Update a registration token

Updates a registration token. You need to send expires_at and max_use on every update, even if you aren't changing them. The name and connector_pool fields are optional and are left unchanged if you omit them.

The expires_at value needs to be in the future and no later than the end of the day that's the tenant's maximum valid days from now. The max_use value can't exceed the tenant's maximum. The name needs to be unique within the connector pool.

The generate_embedded_img flag is ignored if the token's image_url is already IN_PROGRESS, AWS_EMBEDDED_TEMPLATE, or AZURE_EMBEDDED_TEMPLATE. If you set generate_embedded_img to true, also send connector_pool. If you set it to true and the token has already reached its maximum usage, the request fails with a 400 error.

Path Params
string
required

The unique identifier of the registration token.

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

Registration token updates. You need to send expires_at and max_use on every update.

string
length ≥ 1

Identifies the connector pool to link with the token.

date-time
required

The time the 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. It's ignored if the token's image_url is already IN_PROGRESS, AWS_EMBEDDED_TEMPLATE, or AZURE_EMBEDDED_TEMPLATE. If you set generate_embedded_img to true, also send connector_pool.

integer
required
≥ 1

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

string
length ≥ 1

The human-readable name for the 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