Skip to main content
PUT
/
api
/
v1
/
organizations
/
{organizationID}
/
users
/
{userID}
Update user
curl --request PUT \
  --url https://api.example.com/api/v1/organizations/{organizationID}/users/{userID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "spec": {
    "subject": "[email protected]",
    "state": "active",
    "groupIDs": [
      "0aaba80d-67ef-4799-b6d9-59f37e2ce2ad"
    ]
  }
}
'
{
  "metadata": {
    "id": "ee45f34b-9685-40d8-8724-23c31252ca46",
    "name": "undefined",
    "organizationId": "d4600d6e-e965-4b44-a808-84fb2fa36702",
    "creationTime": "2024-05-31T14:11:00Z",
    "provisioningStatus": "provisioned",
    "healthStatus": "healthy"
  },
  "spec": {
    "subject": "[email protected]",
    "state": "active",
    "groupIDs": [
      "0aaba80d-67ef-4799-b6d9-59f37e2ce2ad"
    ]
  },
  "status": {
    "lastAcive": "2025-01-12T10:49:13Z"
  }
}

Authorizations

Authorization
string
header
required

Operation requires OAuth 2.0 bearer token authentication.

Path Parameters

organizationID
string
required

An organization ID.

userID
string
required

A user ID.

Body

application/json

Body required to create a user.

A user create/update object.

spec
object
required

A user specification.

metadata
object

Metadata required for all API resource reads and writes.

Response

A user.

A user read object.

metadata
object
required

Metadata required by organization scoped resource reads.

spec
object
required

A user specification.

status
object
required

Additional user metadata.