user

Update user record (SMS number or Display Name only)

post/user/{userID}

Request

  • Base URL
    https://api.zerotier.com/api/v1
  • Auth
    HTTP token

Path parameters

userIDstring required

User ID

Request body

idstring

User ID

orgIdstring

Organization ID

displayNamestring

Display Name

emailstring

User email address

smsNumberstring

SMS number

tokensstring[]

List of API token names.

Example request

{
  "id": "00000000-0000-0000-0000-000000000000",
  "orgId": "00000000-0000-0000-0000-000000000000",
  "globalPermissions": {
    "a": true,
    "d": true,
    "m": true,
    "r": true
  },
  "displayName": "Joe User",
  "email": "user@example.com",
  "auth": {
    "local": "user@example.com",
    "google": "156162346876134683",
    "oidc": "00000000-0000-0000-0000-000000000000"
  },
  "smsNumber": "+1-800-555-1212",
  "tokens": [
    "my-token-id"
  ]
}

Response

User update success

idstring

User ID

orgIdstring

Organization ID

displayNamestring

Display Name

emailstring

User email address

smsNumberstring

SMS number

tokensstring[]

List of API token names.

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "orgId": "00000000-0000-0000-0000-000000000000",
  "globalPermissions": {
    "a": true,
    "d": true,
    "m": true,
    "r": true
  },
  "displayName": "Joe User",
  "email": "user@example.com",
  "auth": {
    "local": "user@example.com",
    "google": "156162346876134683",
    "oidc": "00000000-0000-0000-0000-000000000000"
  },
  "smsNumber": "+1-800-555-1212",
  "tokens": [
    "my-token-id"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.