Generate Credentials For Sync Client
This endpoint is responsible for the generating token/secret for a sync client and returning the new token/secret
Id of the directory.
TENANT
Requested action. Allowed values are ["generate_credentials"]
{
"_links": {
"self": {
"href": "https://example.com/path-to-self"
}
},
"generate_token": true,
"client_id": "my-oauth-grant-client1",
"client_secret": "my-oauth-grant-client1-secret",
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9xxxxHVcA76zjsGN2w",
"access_token_expire_in": 21599,
"token_ttl": 1800
}The resource HATEOAS links. Usually includes a "self" link for this resource
Flag that identify if the sync client require an access token or a id/secret credentials. If true, an access token will be generated and the response will include 'access_token' and 'access_token_expiry'. If false, the response will include 'client_id' and 'client_secret' for the sync client. For an existing sync client, if no value is specified the previously saved value will be used.
OAuth 2.0 Client identifier that the client uses to identify itself during the OAuth2 exchanges.
OAuth 2.0 Client secret
This token can be used to call VMware Identity Manager APIs. The access token is a JSON web token (JWT).
The time (in seconds) this token expires. If the return value is positive, the access token is going to expire in that many seconds. If the return value is 0, the access token already expired.
How long in minutes new access tokens issued to this client should live. For an existing sync client, if no value is specified the previously saved value will be used.
Sync client's token/secret is generated
{
"_links": {
"self": {
"href": "https://example.com/path-to-self"
}
},
"generate_token": true,
"client_id": "my-oauth-grant-client1",
"client_secret": "my-oauth-grant-client1-secret",
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9xxxxHVcA76zjsGN2w",
"access_token_expire_in": 21599,
"token_ttl": 1800
}The resource HATEOAS links. Usually includes a "self" link for this resource
Flag that identify if the sync client require an access token or a id/secret credentials. If true, an access token will be generated and the response will include 'access_token' and 'access_token_expiry'. If false, the response will include 'client_id' and 'client_secret' for the sync client. For an existing sync client, if no value is specified the previously saved value will be used.
OAuth 2.0 Client identifier that the client uses to identify itself during the OAuth2 exchanges.
OAuth 2.0 Client secret
This token can be used to call VMware Identity Manager APIs. The access token is a JSON web token (JWT).
The time (in seconds) this token expires. If the return value is positive, the access token is going to expire in that many seconds. If the return value is 0, the access token already expired.
How long in minutes new access tokens issued to this client should live. For an existing sync client, if no value is specified the previously saved value will be used.
Invalid parameters for the generate credentials request.
Unauthorized to generate credentials for the sync client.
Forbidden to generate credentials for the sync client.
The sync client configuration not found for the directory.
More than one sync client configuration was found for the directory.