Generate Credentials For Sync Client
This endpoint is responsible for generating credentials for a sync client, returning the new credentials and invalidating the previous ones. The sync client credentials are either a long-lived access token when generate_token is set to true or a client id and secret when generate_token is set to false.
The ID of the directory
The VMware Identity Services tenant ID
my-tenantRequested action. Allowed values are ["generate_credentials"]
{
"_links": {
"self": {
"href": "https://example.com/path-to-self"
}
},
"generate_token": true,
"client_id": "syncClientIdUhYRj1PAqbYz15qrzam7G1W8rOm8kkPi",
"client_secret": "OlfgF3R9G2yJjOtzIrrwuH5AyOlUv0un",
"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 identifies if the sync client requires 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.The sync client identifier is auto-generated and returned when generate_token is set to false.
OAuth 2.0 Client secret. The secret is auto-generated and returned when generate_token is set to false.For additional security, the secret will not be returned in Get API response.
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.The default value is six months (in minutes).
Sync client's credentials were successfully generated.
{
"_links": {
"self": {
"href": "https://example.com/path-to-self"
}
},
"generate_token": true,
"client_id": "syncClientIdUhYRj1PAqbYz15qrzam7G1W8rOm8kkPi",
"client_secret": "OlfgF3R9G2yJjOtzIrrwuH5AyOlUv0un",
"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 identifies if the sync client requires 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.The sync client identifier is auto-generated and returned when generate_token is set to false.
OAuth 2.0 Client secret. The secret is auto-generated and returned when generate_token is set to false.For additional security, the secret will not be returned in Get API response.
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.The default value is six months (in minutes).
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 was not found.
More than one sync client configuration for the directory were found.