GetTokenForAuthGrantTypeRequest

GetTokenForAuthGrantTypeRequest
GetTokenForAuthGrantTypeRequest

Get token for authorization grant type request.

JSON Example
{
    "accessTokenValiditySeconds": 0,
    "actor_token": "string",
    "actor_token_type": "string",
    "allowed_resource_scope": "string",
    "code": "string",
    "code_verifier": "string",
    "grant_type": "string",
    "maxGroupsInIdToken": 0,
    "orgId": "string",
    "password": "string",
    "redirect_uri": "string",
    "refreshTokenValiditySeconds": 0,
    "refresh_token": "string",
    "scope": "string",
    "servicesPermissionsScopesDto": {
        "servicesScopes": [
            {
                "permissions": [
                    {
                        "permissionId": "string",
                        "resources": [
                            "string"
                        ]
                    }
                ],
                "serviceDefinitionId": "string"
            }
        ]
    },
    "subject_ip": "string",
    "subject_token": "string",
    "subject_token_type": "string",
    "target_audience": "string",
    "username": "string"
}
integer As int32 As int32
accessTokenValiditySeconds
Optional

The validity in seconds for the access token. If a value lower than the client's accessTokenValiditySeconds is provided, the provided accessTokenValiditySeconds value will be used. Else if an invalid value, a value higher than the client's accessTokenValiditySeconds, or no value is provided, then the client's accessTokenValiditySeconds will be used. For example if the client's default accessTokenValiditySeconds is 5 minutes ie 300 seconds, to get a token with only one minute validity provide accessTokenValiditySeconds as 60.

string
actor_token
Optional

Required if the grant_type is 'impersonate_user'. A security token that represents the identity of the acting party. In impersonate_user flow, the token provided MUST BE the access token of the user (i.e. vmware internal personnel) who is acting on behalf of customer.

string
actor_token_type
Optional

Required if the grant_type is 'impersonate_user'. The identifier for the actor token provided as per RFC 8693 https://tools.ietf.org/html/rfc8693#section-3 In 'impersonate_user' flow, this value MUST BE 'urn:ietf:params:oauth:token-type:access_token'.

string
allowed_resource_scope
Optional

List of permissions with resources per service definition, which the access token will be scoped to. Accepts a valid json representation of ServicesPermissionsScopesDto class.

string
code
Optional

Authorization code parameter. Mandatory for grant_type 'authorization_code'.

string
code_verifier
Optional

A high-entropy cryptographic random key using the characters [A-Z] / [a-z] / [0-9] / '-' / '.' / '_' / '~' with a minimum length of 43 characters and a maximum length of 128 characters which was used to generate 'code_challenge' and obtain the authorization code. Required if PKCE was used in the authorization code grant request. For more information, refer the PKCE RFC at https://tools.ietf.org/html/rfc7636.

string
grant_type
Required

OAuth grant types for different use cases.

Possible values are : authorization_code, refresh_token, client_credentials, client_delegate, audience_exchange, context_switch,
integer As int32 As int32
maxGroupsInIdToken
Optional

The maximum number of groups allowed in the ID token.

string
orgId
Optional

Unique identifier (GUID) of the organization. Available for grant_type 'client_credentials', 'password'.

string
password
Optional

The password of the user for whom the token should be returned. Mandatory and available for grant_type 'password'.

string
redirect_uri
Optional

Service redirect uri. Mandatory for grant_type 'authorization_code'.

integer As int32 As int32
refreshTokenValiditySeconds
Optional

The validity in seconds for the refresh token. If a value lower than the client's refreshTokenValiditySeconds is provided, the provided refreshTokenValiditySeconds value will be used. Else if an invalid value, a value higher than the client's refreshTokenValiditySeconds, or no value is provided, then the client's refreshTokenValiditySeconds will be used. For example if the client's default refreshTokenValiditySeconds is 30 minutes ie 1800 seconds, to get a token with one hour validity provide refreshTokenValiditySeconds as 3600.

string
refresh_token
Optional

Refresh token parameter. Available for grant_type 'refresh_token'.

string
scope
Optional

The list of scopes separated by a space and is URL encoded. Scope parameter can be used to request different scopes. The requested scope must not include any scope not originally granted.

servicesPermissionsScopesDto
Optional

servicesPermissionsScopesDto

string
subject_ip
Optional

The original caller's source ip. In case service is doing proxy, this ip must be original caller's ip i.e. originating request client ip.

string
subject_token
Optional

Required if the grant_type is 'client_delegate' or 'impersonate_user'. A security token that represents the identity of the party on behalf of whom the request is being made. In client_delegate flow, the token provided MUST BE the access token of the user. In impersonate_user flow, the token will be user account identifier (email)

string
subject_token_type
Optional

Required if the grant_type is 'client_delegate' or 'impersonate_user'. The identifier for the subject token provided as per RFC 8693 https://tools.ietf.org/html/rfc8693#section-3 In 'client_delegate' flow, this value MUST BE 'urn:ietf:params:oauth:token-type:access_token'. In 'impersonate_user' flow, this value MUST BE 'urn:vmware:params:oauth:token-type:acct'

string
target_audience
Optional

Required if the grant_type is 'audience exchange'. The identifier will be passed on as an audience in the new id token, this value MUST BE used along with grant type 'urn:vmware:params:oauth:grant-type:audience-exchange'.

string
username
Optional

The username value corresponds to the value used when login to the system. Mandatory and available for grant_type 'password'.