Create a Personal-Access-Token (PAT)
Generates a new PAT for the user. Currently only available for machine users. The token will be returned in the response, make sure to store it. PATs are ready-to-use tokens and can be sent directly in the authentication header.
Path Parameters
- userId string required
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.
- application/json
- application/grpc
- application/grpc-web+proto
Request Body required
- expirationDate date-time
The date the token will expire and no logins will be possible
Request Body required
- expirationDate date-time
The date the token will expire and no logins will be possible
Request Body required
- expirationDate date-time
The date the token will expire and no logins will be possible
- 200
- default
OK
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- tokenId string
- token string
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
{
"tokenId": "string",
"token": "string",
"details": {
"sequence": "2",
"creationDate": "2023-05-10",
"changeDate": "2023-05-10",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
- tokenId string
- token string
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
{
"tokenId": "string",
"token": "string",
"details": {
"sequence": "2",
"creationDate": "2023-05-10",
"changeDate": "2023-05-10",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
- tokenId string
- token string
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
{
"tokenId": "string",
"token": "string",
"details": {
"sequence": "2",
"creationDate": "2023-05-10",
"changeDate": "2023-05-10",
"resourceOwner": "69629023906488334"
}
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}