TokenFormData

TokenFormData
TokenFormData
JSON Example
{
    "client_id": "Example_AppID",
    "client_secret": "string",
    "scope": "openid+profile+email+user",
    "redirect_uri": "https://example-app.com/redirect?auth%3Doauth",
    "domain": "example.com",
    "username": "string",
    "password": "string",
    "grant_type": "\"client_credentials\"",
    "code": "string",
    "refresh_token": "string",
    "assertion": "string",
    "subject_token_type": "string",
    "subject_token": "string"
}
string
client_id
Optional

This is the identifier of the OAuth 2.0 client that was registered in VMware Identity Manager.

string
client_secret
Optional

client_secret

string
scope
Optional

The list of scopes of the authorization request separated by a space and is URL encoded. The scopes must be equivalent or a subset of the scopes defined in the OAuth2.0 client.

string
redirect_uri
Optional

Specifies the callback endpoint in your application that will receive the authorization code. It must match the redirect_uri defined in your OAuth2.0 client registration in VMware Identity Manager. When sending the redirect_uri as a URL parameter it has to be URL encoded.

string
domain
Optional

Specifies the user's domain. If this parameter is specified, the login screen will skip the domain selection page. This can be used when it is known that a single domain is used or the domain information can be inferred automatically (from the username for example). This is a VMware Identity Manager optional parameter and is not in the OAuth 2.0 specification.

string
username
Optional

The username, UTF-8 encoded. Required only when grant_type is 'password'

string
password
Optional

The password, UTF-8 encoded. Required only when grant_type is 'password'

string
grant_type
Optional

Specifies the OAuth grant type the client is making. VMware Identity Manager supports the following grant types from the OAuth specifications: authorization_code, password, client_credentials, and refresh_token. VMware Identity Manager also supports the grant type urn:ietf:params:oauth:grant-type:jwt-bearer for using JWTs for authorization as described in the JWT Bearer Token Profiles for OAuth 2.0 specifications.

string
code
Optional

The authorization code received from the authorize request. Required only if the grant_type is 'authorization_code'

string
refresh_token
Optional

The refresh token, which can be used to obtain new access tokens using the same authorization grant

string
assertion
Optional

The assertion being used as an authorization grant.If an assertion is not valid or has expired 'invalid_grant' error code is returned

string
subject_token_type
Optional

subject_token_type

string
subject_token
Optional

subject_token

Parameter To