Skip to main content

Create Application Key

POST 
https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/apps/:appId/keys

Create a new application key, they are used for authorizing API Applications. Key details will be returned in the response, make sure to save it.

Request​

Path Parameters

    projectId stringrequired
    appId stringrequired

Header Parameters

    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data.

Body

required

    type string

    Possible values: [KEY_TYPE_UNSPECIFIED, KEY_TYPE_JSON]

    Default value: KEY_TYPE_UNSPECIFIED

    expirationDate date-time

    The date the key will expire and no logins will be possible

Responses​

A successful response.

Schema

    id string

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
    keyDetails byte
curl -L 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/apps/:appId/keys' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "type": "KEY_TYPE_JSON",
  "expirationDate": "2519-04-01T08:45:00.000000Z"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— pathrequired
— pathrequired
— header
Body required
{
  "type": "KEY_TYPE_JSON",
  "expirationDate": "2519-04-01T08:45:00.000000Z"
}
ResponseClear

Click the Send API Request button above and see the response here!