Skip to main content

Create Key for machine user

POST 
https://$CUSTOM-DOMAIN/management/v1/users/:userId/keys

If a public key is not supplied, a new key is generated and will be returned in the response. Make sure to store the returned key. If an RSA public key is supplied, the private key is omitted from the response. Machine keys are used to authenticate with jwt profile.

Request​

Path Parameters

    userId stringrequired

Header Parameters

    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization.

Body

required

    type string

    Possible values: [KEY_TYPE_UNSPECIFIED, KEY_TYPE_JSON]

    Default value: KEY_TYPE_UNSPECIFIED

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

    expirationDate date-time

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

    publicKey byte

    Optionally provide a public key of your own generated RSA private key.

Responses​

OK

Schema

    keyId string
    keyDetails byte

    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)
curl -L 'https://$CUSTOM-DOMAIN/management/v1/users/:userId/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",
  "publicKey": "LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1..."
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— pathrequired
— header
Body required
{
  "type": "KEY_TYPE_JSON",
  "expirationDate": "2519-04-01T08:45:00.000000Z",
  "publicKey": "LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1..."
}
ResponseClear

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