Create a registration token

Creates a registration token for a connector pool.

The expires_at value needs to be in the future and no later than the end of the day 7 days from now by default. Your tenant's maximum valid days setting can change this limit. The max_use value can't exceed the tenant's maximum, which is 10 by default. The name needs to be unique within the connector pool, and the connector_pool needs to exist. Otherwise the request fails with a 400 error.

If you set generate_embedded_img to true, the image_url in the response is AWS_EMBEDDED_TEMPLATE or AZURE_EMBEDDED_TEMPLATE for AWS and Azure connector pools. For other pools it's IN_PROGRESS while the image is generated. Otherwise image_url is NOT_AVAILABLE.

Query Params
string

The Akamai contract identifier for your Enterprise Application Access product.

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Request body to create a registration token.

string
required
length ≥ 1

Identifies the connector pool to link with the token. The connector pool needs to exist.

date-time
required

The time when the new token will expire. It needs to be in the future and within the tenant's maximum valid days.

boolean
Defaults to false

Whether to generate an embedded connector image for the token. See the operation description for the resulting image_url values.

integer
required
≥ 1

The maximum number of times the token may be used. It can't exceed the tenant's maximum.

string
required
length ≥ 1

The human-readable name for the new registration token. It needs to be unique within the connector pool.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json