User
Update a user
Backend API Documentation
Tenant
- GETGet Tenant brand properties
- PUTUpdate Tenant brand properties
- GETGet an Auth Tenant env vars
- POSTRotate Tenant secret key
- GETGet all Tenants
- POSTCreate Tenant
- GETGet Tenant by public key
- GET[tenants.getBySlug] Get Tenant by slug
- GETGet Tenant by id
- PUTUpdate Tenant
- DELDelete Tenant
- GETGet Tenant subscription
- GETGet Tenant members
- DELDelete Tenant member
- PATCHUpdate Tenant member
- POSTInvite Tenant member
- GETGet Tenant invitations
- DELDelete Tenant invitation
- PATCHUpdate Tenant invitation
- GETGet an Tenant
- PUTUpdate an Tenant
- PUTUpdate an Tenant's session settings
Domain
Stats
User
- GETGet all users
- POSTCreate a user
- GETGet a user
- PUTUpdate a user
- DELDelete a user
- PUTChange a user's password
- PUTSuspend a user
- PUTUnsuspend a user
- GETGet all PhoneNumbers for a tenant
- GETGet all User PhoneNumbers
- GETGet a User PhoneNumber
- POSTCreate a User PhoneNumber
- DELDelete an PhoneNumber
- POSTMake an PhoneNumber the primary PhoneNumber for a User
- POSTVerify an PhoneNumber
- GETGet all User EmailAddresses
- GETGet all User EmailAddresses
- GETGet a User EmailAddress
- PUTUpdate a User EmailAddress
- POSTCreate a User EmailAddress
- DELDelete an EmailAddress
- POSTMake an EmailAddress the primary EmailAddress for a User
- POSTVerify an EmailAddress
- GETGet the current user
- GETList all Tenant Invitations for the current user
- POSTAccept a Tenant Invitation
- POSTDecline a Tenant Invitation
Organization
OrganizationMembership
OrganizationInvitation
SocialProvider
JWKCertificate
Upload
Transformation
NotificationTemplate
- GETGet all NotificationTemplates
- GETGet NotificationTemplate by id
- PUTUpdate NotificationTemplate
- DELDelete NotificationTemplate
- POSTCreate NotificationTemplate
- GETGet NotificationTemplate content
- PUTUpdate NotificationTemplate content
- POSTTest NotificationTemplate
- POSTClone all NotificationTemplates to a new tenant
Notification
User
Update a user
PUT
/
auth
/
users
/
{id}
curl --request PUT \
--url https://api.pxyz.dev/api/v0/auth/users/{id} \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"username": "<string>",
"imageUri": "",
"roleId": "<string>",
"status": "active",
"locale": "<string>",
"timezone": "<string>",
"primaryEmailId": "<string>",
"primaryPhoneId": "<string>",
"publicMeta": "<any>",
"privateMeta": "<any>"
}'{
"id": "<string>",
"tenantId": "<string>",
"name": "<string>",
"imageUri": "<string>",
"lastSignInAt": "2023-11-07T05:31:56Z",
"lastActiveAt": "2023-11-07T05:31:56Z",
"username": "<string>",
"status": "active",
"roleId": "<string>",
"role": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"permissions": [
"<string>"
]
},
"primaryEmailId": "<string>",
"primaryPhoneId": "<string>",
"emailAddresses": [
{
"id": "<string>",
"tenantId": "<string>",
"userId": "<string>",
"email": "jsmith@example.com",
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"phoneNumbers": [
{
"id": "<string>",
"tenantId": "<string>",
"userId": "<string>",
"phone": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"publicMeta": "<any>",
"privateMeta": "<any>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Path Parameters
Body
application/json
Available options:
Available options:
active, inactive, suspended Response
200
application/json
Successful response
Available options:
active, inactive, suspended curl --request PUT \
--url https://api.pxyz.dev/api/v0/auth/users/{id} \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"username": "<string>",
"imageUri": "",
"roleId": "<string>",
"status": "active",
"locale": "<string>",
"timezone": "<string>",
"primaryEmailId": "<string>",
"primaryPhoneId": "<string>",
"publicMeta": "<any>",
"privateMeta": "<any>"
}'{
"id": "<string>",
"tenantId": "<string>",
"name": "<string>",
"imageUri": "<string>",
"lastSignInAt": "2023-11-07T05:31:56Z",
"lastActiveAt": "2023-11-07T05:31:56Z",
"username": "<string>",
"status": "active",
"roleId": "<string>",
"role": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"permissions": [
"<string>"
]
},
"primaryEmailId": "<string>",
"primaryPhoneId": "<string>",
"emailAddresses": [
{
"id": "<string>",
"tenantId": "<string>",
"userId": "<string>",
"email": "jsmith@example.com",
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"phoneNumbers": [
{
"id": "<string>",
"tenantId": "<string>",
"userId": "<string>",
"phone": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"publicMeta": "<any>",
"privateMeta": "<any>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}