Skip to main content

Create User (Machine)

POST 
https://$CUSTOM-DOMAIN/management/v1/users/machine

Create a new user with the type machine for your API, service or device. These users are used for non-interactive authentication flows.

Request​

Header Parameters

    x-zitadel-orgid string

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

Body

required

    userName stringrequired

    Possible values: non-empty and <= 200 characters

    name stringrequired

    Possible values: non-empty and <= 200 characters

    description string

    Possible values: <= 500 characters

    accessTokenType string

    Possible values: [ACCESS_TOKEN_TYPE_BEARER, ACCESS_TOKEN_TYPE_JWT]

    Default value: ACCESS_TOKEN_TYPE_BEARER

    userId string

    Possible values: <= 200 characters

    optionally set your own id unique for the user.

Responses​

OK

Schema

    userId 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)
curl -L 'https://$CUSTOM-DOMAIN/management/v1/users/machine' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "userName": "robot",
  "name": "My Machine Account",
  "description": "First machine account used for API XY.",
  "accessTokenType": "ACCESS_TOKEN_TYPE_BEARER",
  "userId": "316b7fa5-0535-4adb-9e93-963a91b1010c"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— header
Body required
{
  "userName": "robot",
  "name": "My Machine Account",
  "description": "First machine account used for API XY.",
  "accessTokenType": "ACCESS_TOKEN_TYPE_BEARER",
  "userId": "316b7fa5-0535-4adb-9e93-963a91b1010c"
}
ResponseClear

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