Get Broker Sync Client

This endpoint is responsible retrieving the configuration of the directory sync client.

Request

URI

GET

https://{api_host}//usergroup/t/{tenant}/broker/directories/{id}/sync-client

COPY

Path Parameters

string

Required

The ID of the directory

string

tenant

Required

The VMware Identity Services tenant ID

tenant example

my-tenant

Authentication

This operation uses the following authentication methods.

admin

Responses

200

Successfully fetched directory sync client configuration.

Returns BrokerSyncClientConfigurationMedia of type(s) application/vnd.vmware.vidm.usergroup.broker.directory.syncclientconfiguration+json

{
    "_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
}

object

_links

Optional

The resource HATEOAS links. Usually includes a "self" link for this resource

boolean

generate_token

Optional

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.

string

client_id

Optional

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.

string

client_secret

Optional

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.

string

access_token

Optional

This token can be used to call VMware Identity Manager APIs. The access token is a JSON web token (JWT).

integer As int64 As int64

access_token_expire_in

Optional

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.

integer As int32 As int32

token_ttl

Optional

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).

401

Unauthorized to get the sync client configuration.

Operation doesn't return any data structure

403

Forbidden to get the sync client configuration.

Operation doesn't return any data structure

404

The sync client configuration for the directory was not found.

Operation doesn't return any data structure

409

More than one sync client configuration were found for the directory.

Operation doesn't return any data structure