admin-key

disable-admin-key

Disable Admin Key

Disables admin key access for the calling user within the site.

Permissions required: User must be an organization or site admin.

DELETE /admin-key

Example:

cf admin-key disable-admin-key

enable-admin-key

Enable Admin Key

Enables admin key access for the calling user within the site. If an admin key already exists for the user, a new one will be issued with an updated expiration time.

Note: The durationInMinutes field within the request body is optional. If the request body is empty or if the durationInMinutes is set to 0 minutes, a new admin key will be issued to the calling user with a default duration of 10 minutes.

Permissions required: User must be an organization or site admin.

POST /admin-key

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

cf admin-key enable-admin-key

get-admin-key

Get Admin Key

Returns information about the admin key if one is currently enabled for the calling user within the site.

Permissions required: User must be an organization or site admin.

GET /admin-key

Example:

cf admin-key get-admin-key