| WebDocumentationInvalidHeaderErrorMessage |
Invalid header '{0}' |
| WebDocumentationInvalidRequestErrorMessage |
Invalid Request URL |
| TextboxLabelAccessToken |
Access token * |
| DropdownOptionPrimaryKeyFormat |
Primary-{0} |
| DropdownOptionSecondaryKeyFormat |
Secondary-{0} |
| WebDocumentationSubscriptionKeyText |
Your subscription key |
| WebDocumentationTemplatesAddHeaders |
Add required HTTP headers |
| WebDocumentationTemplatesBasicAuthSample |
Basic Authorization Sample |
| WebDocumentationTemplatesCurlForBasicAuth |
for Basic Authorization use: --user {username}:{password} |
| WebDocumentationTemplatesCurlValuesForPath |
Specify values for path parameters (shown as {...}), your subscription key and values for query parameters |
| WebDocumentationTemplatesDeveloperKey |
Specify your subscription key |
| WebDocumentationTemplatesJavaApache |
This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/) |
| WebDocumentationTemplatesOptionalParams |
Specify values for optional parameters, as needed |
| WebDocumentationTemplatesPhpPackage |
This sample uses the HTTP_Request2 package. (for more information: https://pear.php.net/package/HTTP_Request2) |
| WebDocumentationTemplatesPythonValuesForPath |
Specify values for path parameters (shown as {...}) and request body if needed |
| WebDocumentationTemplatesRequestBody |
Specify request body |
| WebDocumentationTemplatesRequiredParams |
Specify values for the following required parameters |
| WebDocumentationTemplatesValuesForPath |
Specify values for path parameters (shown as {...}) |
| OAuth2AuthorizationEndpointDescription |
The authorization endpoint is used to interact with the resource owner and obtain an authorization grant. |
| OAuth2AuthorizationEndpointName |
Authorization endpoint |
| OAuth2TokenEndpointDescription |
The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token. |
| OAuth2TokenEndpointName |
Token endpoint |
| OAuth2Flow_AuthorizationCodeGrant_Step_AuthorizationRequest_Description |
<p> The client initiates the flow by directing the resource owner's user-agent to the authorization endpoint. The client includes its client identifier, requested scope, local state, and a redirection URI to which the authorization server will send the user-agent back once access is granted (or denied). </p> <p> The authorization server authenticates the resource owner (via the user-agent) and establishes whether the resource owner grants or denies the client's access request. </p> <p> Assuming the resource owner grants access, the authorization server redirects the user-agent back to the client using the redirection URI provided earlier (in the request or during client registration). The redirection URI includes an authorization code and any local state provided by the client earlier. </p> |
| OAuth2Flow_AuthorizationCodeGrant_Step_AuthorizationRequest_ErrorDescription |
<p> If the user denies the access request of if the request is invalid, the client will be informed using the following parameters added on to the redirect: </p> |
| OAuth2Flow_AuthorizationCodeGrant_Step_AuthorizationRequest_Name |
Authorization request |
| OAuth2Flow_AuthorizationCodeGrant_Step_AuthorizationRequest_RequestDescription |
<p> The client app must send the user to the authorization endpoint in order to initiate the OAuth process. At the authorization endpoint, the user authenticates and then grants or denies access to the app. </p> |
| OAuth2Flow_AuthorizationCodeGrant_Step_AuthorizationRequest_ResponseDescription |
<p> Assuming the resource owner grants access, authorization server redirects the user-agent back to the client using the redirection URI provided earlier (in the request or during client registration). The redirection URI includes an authorization code and any local state provided by the client earlier. </p> |
| OAuth2Flow_AuthorizationCodeGrant_Step_TokenRequest_Description |
<p> The client requests an access token from the authorization server''s token endpoint by including the authorization code received in the previous step. When making the request, the client authenticates with the authorization server. The client includes the redirection URI used to obtain the authorization code for verification. </p> <p> The authorization server authenticates the client, validates the authorization code, and ensures that the redirection URI received matches the URI used to redirect the client in step (C). If valid, the authorization server responds back with an access token and, optionally, a refresh token. </p> |
| OAuth2Flow_AuthorizationCodeGrant_Step_TokenRequest_ErrorDescription |
<p> If the request client authentication failed or is invalid, the authorization server responds with an HTTP 400 (Bad Request) status code (unless specified otherwise) and includes the following parameters with the response. </p> |
| OAuth2Flow_AuthorizationCodeGrant_Step_TokenRequest_RequestDescription |
<p> The client makes a request to the token endpoint by sending the following parameters using the "application/x-www-form-urlencoded" format with a character encoding of UTF-8 in the HTTP request entity-body. </p> |
| OAuth2Flow_AuthorizationCodeGrant_Step_TokenRequest_ResponseDescription |
<p> The authorization server issues an access token and optional refresh token, and constructs the response by adding the following parameters to the entity-body of the HTTP response with a 200 (OK) status code. </p> |
| OAuth2Flow_ClientCredentialsGrant_Step_TokenRequest_Description |
<p> The client authenticates with the authorization server and requests an access token from the token endpoint. </p> <p> The authorization server authenticates the client, and if valid, issues an access token. </p> |
| OAuth2Flow_ClientCredentialsGrant_Step_TokenRequest_ErrorDescription |
<p> If the request failed client authentication or is invalid the authorization server responds with an HTTP 400 (Bad Request) status code (unless specified otherwise) and includes the following parameters with the response. </p> |
| OAuth2Flow_ClientCredentialsGrant_Step_TokenRequest_RequestDescription |
<p> The client makes a request to the token endpoint by adding the following parameters using the "application/x-www-form-urlencoded" format with a character encoding of UTF-8 in the HTTP request entity-body. </p> |
| OAuth2Flow_ClientCredentialsGrant_Step_TokenRequest_ResponseDescription |
<p> If the access token request is valid and authorized, the authorization server issues an access token and optional refresh token, and constructs the response by adding the following parameters to the entity-body of the HTTP response with a 200 (OK) status code. </p> |
| OAuth2Flow_ImplicitGrant_Step_AuthorizationRequest_Description |
<p> The client initiates the flow by directing the resource owner''s user-agent to the authorization endpoint. The client includes its client identifier, requested scope, local state, and a redirection URI to which the authorization server will send the user-agent back once access is granted (or denied). </p> <p> The authorization server authenticates the resource owner (via the user-agent) and establishes whether the resource owner grants or denies the client''s access request. </p> <p> Assuming the resource owner grants access, the authorization server redirects the user-agent back to the client using the redirection URI provided earlier. The redirection URI includes the access token in the URI fragment. </p> |
| OAuth2Flow_ImplicitGrant_Step_AuthorizationRequest_ErrorDescription |
<p> If the resource owner denies the access request or if the request fails for reasons other than a missing or invalid redirection URI, the authorization server informs the client by adding the following parameters to the fragment component of the redirection URI using the "application/x-www-form-urlencoded" format. </p> |
| OAuth2Flow_ImplicitGrant_Step_AuthorizationRequest_RequestDescription |
<p> The client app must send the user to the authorization endpoint in order to initiate the OAuth process. At the authorization endpoint, the user authenticates and then grants or denies access to the app. </p> |
| OAuth2Flow_ImplicitGrant_Step_AuthorizationRequest_ResponseDescription |
<p> If the resource owner grants the access request, the authorization server issues an access token and delivers it to the client by adding the following parameters to the fragment component of the redirection URI using the "application/x-www-form-urlencoded" format. </p> |
| OAuth2Flow_ObtainAuthorization_AuthorizationCodeGrant_Description |
Authorization code flow is optimized for clients capable of maintaining the confidentiality of their credentials (e.g., web server applications implemented using PHP, Java, Python, Ruby, ASP.NET, etc.). |
| OAuth2Flow_ObtainAuthorization_AuthorizationCodeGrant_Name |
Authorization Code grant |
| OAuth2Flow_ObtainAuthorization_ClientCredentialsGrant_Description |
Client credentials flow is suitable in cases where the client (your application) is requesting access to the protected resources under its control. The client is considered as a resource owner, so no end-user interaction is required. |
| OAuth2Flow_ObtainAuthorization_ClientCredentialsGrant_Name |
Client Credentials grant |
| OAuth2Flow_ObtainAuthorization_ImplicitGrant_Description |
Implicit flow is optimized for clients incapable of maintaining the confidentiality of their credentials known to operate a particular redirection URI. These clients are typically implemented in a browser using a scripting language such as JavaScript. |
| OAuth2Flow_ObtainAuthorization_ImplicitGrant_Name |
Implicit grant |
| OAuth2Flow_ObtainAuthorization_ResourceOwnerPasswordCredentialsGrant_Description |
Resource owner password credentials flow is suitable in cases where the resource owner has a trust relationship with the client (your application), such as the device operating system or a highly privileged application. This flow is suitable for clients capable of obtaining the resource owner's credentials (username and password, typically using an interactive form). |
| OAuth2Flow_ObtainAuthorization_ResourceOwnerPasswordCredentialsGrant_Name |
Resource Owner Password Credentials grant |
| OAuth2Flow_ResourceOwnerPasswordCredentialsGrant_Step_TokenRequest_Description |
<p> The resource owner provides the client with its username and password. </p> <p> The client requests an access token from the authorization server''s token endpoint by including the credentials received from the resource owner. When making the request, the client authenticates with the authorization server. </p> <p> The authorization server authenticates the client and validates the resource owner credentials, and if valid, issues an access token. </p> |
| OAuth2Flow_ResourceOwnerPasswordCredentialsGrant_Step_TokenRequest_ErrorDescription |
<p> If the request failed client authentication or is invalid the authorization server responds with an HTTP 400 (Bad Request) status code (unless specified otherwise) and includes the following parameters with the response. </p> |
| OAuth2Flow_ResourceOwnerPasswordCredentialsGrant_Step_TokenRequest_RequestDescription |
<p> The client makes a request to the token endpoint by adding the following parameters using the "application/x-www-form-urlencoded" format with a character encoding of UTF-8 in the HTTP request entity-body. </p> |
| OAuth2Flow_ResourceOwnerPasswordCredentialsGrant_Step_TokenRequest_ResponseDescription |
<p> If the access token request is valid and authorized, the authorization server issues an access token and optional refresh token, and constructs the response by adding the following parameters to the entity-body of the HTTP response with a 200 (OK) status code. </p> |
| OAuth2Step_AccessTokenRequest_Name |
Access token request |
| OAuth2Step_AuthorizationRequest_Name |
Authorization request |
| OAuth2AccessToken_AuthorizationCodeGrant_TokenResponse |
REQUIRED. The access token issued by the authorization server. |
| OAuth2AccessToken_ClientCredentialsGrant_TokenResponse |
REQUIRED. The access token issued by the authorization server. |
| OAuth2AccessToken_ImplicitGrant_AuthorizationResponse |
REQUIRED. The access token issued by the authorization server. |
| OAuth2AccessToken_ResourceOwnerPasswordCredentialsGrant_TokenResponse |
REQUIRED. The access token issued by the authorization server. |
| OAuth2ClientId_AuthorizationCodeGrant_AuthorizationRequest |
REQUIRED. Client identifier. |
| OAuth2ClientId_AuthorizationCodeGrant_TokenRequest |
REQUIRED if the client is not authenticating with the authorization server. |
| OAuth2ClientId_ImplicitGrant_AuthorizationRequest |
REQUIRED. The client identifier. |
| OAuth2Code_AuthorizationCodeGrant_AuthorizationResponse |
REQUIRED. The authorization code generated by the authorization server. |
| OAuth2Code_AuthorizationCodeGrant_TokenRequest |
REQUIRED. The authorization code received from the authorization server. |
| OAuth2ErrorDescription_AuthorizationCodeGrant_AuthorizationErrorResponse |
OPTIONAL. Human-readable ASCII text providing additional information. |
| OAuth2ErrorDescription_AuthorizationCodeGrant_TokenErrorResponse |
OPTIONAL. Human-readable ASCII text providing additional information. |
| OAuth2ErrorDescription_ClientCredentialsGrant_TokenErrorResponse |
OPTIONAL. Human-readable ASCII text providing additional information. |
| OAuth2ErrorDescription_ImplicitGrant_AuthorizationErrorResponse |
OPTIONAL. Human-readable ASCII text providing additional information. |
| OAuth2ErrorDescription_ResourceOwnerPasswordCredentialsGrant_TokenErrorResponse |
OPTIONAL. Human-readable ASCII text providing additional information. |
| OAuth2ErrorUri_AuthorizationCodeGrant_AuthorizationErrorResponse |
OPTIONAL. A URI identifying a human-readable web page with information about the error. |
| OAuth2ErrorUri_AuthorizationCodeGrant_TokenErrorResponse |
OPTIONAL. A URI identifying a human-readable web page with information about the error. |
| OAuth2ErrorUri_ClientCredentialsGrant_TokenErrorResponse |
OPTIONAL. A URI identifying a human-readable web page with information about the error. |
| OAuth2ErrorUri_ImplicitGrant_AuthorizationErrorResponse |
OPTIONAL. A URI identifying a human-readable web page with information about the error. |
| OAuth2ErrorUri_ResourceOwnerPasswordCredentialsGrant_TokenErrorResponse |
OPTIONAL. A URI identifying a human-readable web page with information about the error. |
| OAuth2Error_AuthorizationCodeGrant_AuthorizationErrorResponse |
REQUIRED. A single ASCII error code from the following: invalid_request, unauthorized_client, access_denied, unsupported_response_type, invalid_scope, server_error, temporarily_unavailable. |
| OAuth2Error_AuthorizationCodeGrant_TokenErrorResponse |
REQUIRED. A single ASCII error code from the following: invalid_request, invalid_client, invalid_grant, unauthorized_client, unsupported_grant_type, invalid_scope. |
| OAuth2Error_ClientCredentialsGrant_TokenErrorResponse |
REQUIRED. A single ASCII error code from the following: invalid_request, invalid_client, invalid_grant, unauthorized_client, unsupported_grant_type, invalid_scope. |
| OAuth2Error_ImplicitGrant_AuthorizationErrorResponse |
REQUIRED. A single ASCII error code from the following: invalid_request, unauthorized_client, access_denied, unsupported_response_type, invalid_scope, server_error, temporarily_unavailable. |
| OAuth2Error_ResourceOwnerPasswordCredentialsGrant_TokenErrorResponse |
REQUIRED. A single ASCII error code from the following: invalid_request, invalid_client, invalid_grant, unauthorized_client, unsupported_grant_type, invalid_scope. |
| OAuth2ExpiresIn_AuthorizationCodeGrant_TokenResponse |
RECOMMENDED. The lifetime in seconds of the access token. |
| OAuth2ExpiresIn_ClientCredentialsGrant_TokenResponse |
RECOMMENDED. The lifetime in seconds of the access token. |
| OAuth2ExpiresIn_ImplicitGrant_AuthorizationResponse |
RECOMMENDED. The lifetime in seconds of the access token. |
| OAuth2ExpiresIn_ResourceOwnerPasswordCredentialsGrant_TokenResponse |
RECOMMENDED. The lifetime in seconds of the access token. |
| OAuth2GrantType_AuthorizationCodeGrant_TokenRequest |
REQUIRED. Value MUST be set to "authorization_code". |
| OAuth2GrantType_ClientCredentialsGrant_TokenRequest |
REQUIRED. Value MUST be set to "client_credentials". |
| OAuth2GrantType_ResourceOwnerPasswordCredentialsGrant_TokenRequest |
REQUIRED. Value MUST be set to "password". |
| OAuth2Password_ResourceOwnerPasswordCredentialsGrant_TokenRequest |
REQUIRED. The resource owner password. |
| OAuth2RedirectUri_AuthorizationCodeGrant_AuthorizationRequest |
OPTIONAL. The redirection endpoint URI must be an absolute URI. |
| OAuth2RedirectUri_AuthorizationCodeGrant_TokenRequest |
REQUIRED if the "redirect_uri" parameter was included in the authorization request, and their values MUST be identical. |
| OAuth2RedirectUri_ImplicitGrant_AuthorizationRequest |
OPTIONAL. The redirection endpoint URI must be an absolute URI. |
| OAuth2RefreshToken_AuthorizationCodeGrant_TokenResponse |
OPTIONAL. The refresh token, which can be used to obtain new access tokens. |
| OAuth2RefreshToken_ClientCredentialsGrant_TokenResponse |
OPTIONAL. The refresh token, which can be used to obtain new access tokens. |
| OAuth2RefreshToken_ResourceOwnerPasswordCredentialsGrant_TokenResponse |
OPTIONAL. The refresh token, which can be used to obtain new access tokens. |
| OAuth2ResponseType_AuthorizationCodeGrant_AuthorizationRequest |
REQUIRED. Value MUST be set to "code". |
| OAuth2ResponseType_ImplicitGrant_AuthorizationRequest |
REQUIRED. Value MUST be set to "token". |
| OAuth2Scope_AuthorizationCodeGrant_AuthorizationRequest |
OPTIONAL. The scope of the access request. |
| OAuth2Scope_AuthorizationCodeGrant_TokenResponse |
OPTIONAL if identical to the scope requested by the client; otherwise, REQUIRED. |
| OAuth2Scope_ClientCredentialsGrant_TokenRequest |
OPTIONAL. The scope of the access request. |
| OAuth2Scope_ClientCredentialsGrant_TokenResponse |
OPTIONAL, if identical to the scope requested by the client; otherwise, REQUIRED. |
| OAuth2Scope_ImplicitGrant_AuthorizationRequest |
OPTIONAL. The scope of the access request. |
| OAuth2Scope_ImplicitGrant_AuthorizationResponse |
OPTIONAL if identical to the scope requested by the client; otherwise, REQUIRED. |
| OAuth2Scope_ResourceOwnerPasswordCredentialsGrant_TokenRequest |
OPTIONAL. The scope of the access request. |
| OAuth2Scope_ResourceOwnerPasswordCredentialsGrant_TokenResponse |
OPTIONAL, if identical to the scope requested by the client; otherwise, REQUIRED. |
| OAuth2State_AuthorizationCodeGrant_AuthorizationErrorResponse |
REQUIRED if the "state" parameter was present in the client authorization request. The exact value received from the client. |
| OAuth2State_AuthorizationCodeGrant_AuthorizationRequest |
RECOMMENDED. An opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client. The parameter SHOULD be used for preventing cross-site request forgery. |
| OAuth2State_AuthorizationCodeGrant_AuthorizationResponse |
REQUIRED if the "state" parameter was present in the client authorization request. The exact value received from the client. |
| OAuth2State_ImplicitGrant_AuthorizationErrorResponse |
REQUIRED if the "state" parameter was present in the client authorization request. The exact value received from the client. |
| OAuth2State_ImplicitGrant_AuthorizationRequest |
RECOMMENDED. An opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client. The parameter SHOULD be used for preventing cross-site request forgery. |
| OAuth2State_ImplicitGrant_AuthorizationResponse |
REQUIRED if the "state" parameter was present in the client authorization request. The exact value received from the client. |
| OAuth2TokenType_AuthorizationCodeGrant_TokenResponse |
REQUIRED. The type of the token issued. |
| OAuth2TokenType_ClientCredentialsGrant_TokenResponse |
REQUIRED. The type of the token issued. |
| OAuth2TokenType_ImplicitGrant_AuthorizationResponse |
REQUIRED. The type of the token issued. |
| OAuth2TokenType_ResourceOwnerPasswordCredentialsGrant_TokenResponse |
REQUIRED. The type of the token issued. |
| OAuth2UserName_ResourceOwnerPasswordCredentialsGrant_TokenRequest |
REQUIRED. The resource owner username. |
| OAuth2UnsupportedTokenType |
Token type '{0}' is not supported. |
| OAuth2InvalidState |
Invalid response from authorization server |
| OAuth2GrantType_AuthorizationCode |
Authorization code |
| OAuth2GrantType_Implicit |
Implicit |
| OAuth2GrantType_ClientCredentials |
Client credentials |
| OAuth2GrantType_ResourceOwnerPassword |
Resource owner password |
| WebDocumentation302Code |
302 Found |
| WebDocumentation400Code |
400 (Bad request) |
| OAuth2SendingMethod_AuthHeader |
Authorization header |
| OAuth2SendingMethod_QueryParam |
Query parameter |
| OAuth2AuthorizationServerGeneralException |
An error has occurred while authorizing access via {0} |
| OAuth2AuthorizationServerCommunicationException |
An HTTP connection to authorization server could not be established or it has been unexpectedly closed. |
| WebDocumentationOAuth2GeneralErrorMessage |
Unexpected error occurred. |
| AuthorizationServerCommunicationException |
Authorization server communication exception has happened. Please contact administrator. |
| TextblockSubscriptionKeyHeaderDescription |
Subscription key which provides access to this API. Found in your <a href='/developer'>Profile</a>. |
| TextblockOAuthHeaderDescription |
OAuth 2.0 access token obtained from <i>{0}</i>. Supported grant types: <i>{1}</i>. |
| TextblockContentTypeHeaderDescription |
Media type of the body sent to the API. |
| ErrorMessageApiNotAccessible |
The API you are trying to call is not accessible at this time. Please contact the API publisher <a href="/issues">here</a>. |
| ErrorMessageApiTimedout |
The API you are trying to call is taking longer than normal to get response back. Please contact the API publisher <a href="/issues">here</a>. |
| BadRequestParameterExpected |
"'{0}' parameter is expected" |
| TooltipTextDoubleClickToSelectAll |
Double click to select all. |
| TooltipTextHideRevealSecret |
Show/Hide |
| ButtonLinkOpenConsole |
Try it |
| SectionHeadingRequestBody |
Request body |
| SectionHeadingRequestParameters |
Request parameters |
| SectionHeadingRequestUrl |
Request URL |
| SectionHeadingResponse |
Response |
| SectionHeadingRequestHeaders |
Request headers |
| FormLabelSubtextOptional |
optional |
| SectionHeadingCodeSamples |
Code samples |
| TextblockOpenidConnectHeaderDescription |
OpenID Connect ID token obtained from <i>{0}</i>. Supported grant types: <i>{1}</i>. |