User
Create Personal Access Token (PAT)
- Documentation
- Community
- Blog
- Overview
Authentication
Email and Password
Passwordless
OAuth
WebAuthn
Anonymous
MFA
User
- POSTSign Out
Storage
AI
JavaScript
React
Next.js
Vue
API Documentation
Backend Services
GraphQL
Client Libraries
User
Create Personal Access Token (PAT)
POST
/
pat
Authorization
string
*
Bearer
Authorization
Required
string
JSON Web Token to authorize requests.
object
*
expiresAt
string
*
expiresAt
Required
string
The expiration date and time of the personal access token
Add Example Value
metadata
object
metadata
object
Additional metadata associated with the personal access token
curl --request POST \
--url https://local.auth.nhost.run/v1/pat \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"expiresAt": "2023-11-07T05:31:56Z",
"metadata": {}
}'
{
"accessToken": "<string>",
"accessTokenExpiresIn": 123,
"refreshToken": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
"user": {
"activeMfaType": "totp",
"avatarUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultRole": "user",
"displayName": "John Smith",
"email": "john.smith@nhost.io",
"emailVerified": true,
"id": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
"isAnonymous": true,
"locale": "en",
"metadata": {
"firstName": "John",
"lastName": "Smith"
},
"phoneNumber": "<string>",
"phoneNumberVerified": true,
"roles": [
"me",
"user"
]
}
}
Authorizations
Authorization
string
headerrequiredJSON Web Token to authorize requests.
Body
application/json
expiresAt
string
requiredThe expiration date and time of the personal access token
metadata
object
Additional metadata associated with the personal access token
Response
200 - application/json
accessToken
string
requiredaccessTokenExpiresIn
number
requiredrefreshToken
string
requiredRefresh token during authentication or when refreshing the JWT
user
object
user.activeMfaType
required
Multi-factor authentication type. A null value deactivates MFA
Available options:
totp
user.avatarUrl
string
requireduser.createdAt
string
requireduser.defaultRole
enum<string>
default: userrequiredAvailable options:
me
, user
user.displayName
string
requireduser.email
string
requiredA valid email
user.emailVerified
boolean
default: falserequireduser.id
string
Id of the user
user.isAnonymous
boolean
default: falserequireduser.locale
string
default: enrequiredA two-characters locale
user.metadata
object
requireduser.phoneNumber
string
requireduser.phoneNumberVerified
boolean
default: falserequireduser.roles
enum<string>[]
requiredAvailable options:
me
curl --request POST \
--url https://local.auth.nhost.run/v1/pat \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"expiresAt": "2023-11-07T05:31:56Z",
"metadata": {}
}'
{
"accessToken": "<string>",
"accessTokenExpiresIn": 123,
"refreshToken": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
"user": {
"activeMfaType": "totp",
"avatarUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultRole": "user",
"displayName": "John Smith",
"email": "john.smith@nhost.io",
"emailVerified": true,
"id": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
"isAnonymous": true,
"locale": "en",
"metadata": {
"firstName": "John",
"lastName": "Smith"
},
"phoneNumber": "<string>",
"phoneNumberVerified": true,
"roles": [
"me",
"user"
]
}
}