Update user

Rotate the password on an existing username/password user.

cURL

curl -X PUT "$API_BASE_URL/v1/org/$ORG_ID/contexts/sign-in/$CTX_ID/modules/up/update" \
  -H "x-auth-token: $NETGRAPH_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "alice.smith",
    "password": "N3w-P@ssw0rd"
  }'

200

{
  "username": "alice.smith",
  "password": "N3w-P@ssw0rd"
}

Updates an existing username/password user. Use this to rotate passwords or correct a mis-provisioned account.

Request

organizationId · string · required

Organization ID.

contextId · string · required

Sign-In Context ID.

x-auth-token · string · required

Context API key.

username · string · required

Username of the user to update. Must already exist in the Context.

password · string · required

New password. Must satisfy the Context’s password policy.

cURL

curl -X PUT "$API_BASE_URL/v1/org/$ORG_ID/contexts/sign-in/$CTX_ID/modules/up/update" \
  -H "x-auth-token: $NETGRAPH_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "alice.smith",
    "password": "N3w-P@ssw0rd"
  }'

Response

username · string

The user’s username.

password · string

The updated password.

200

{
  "username": "alice.smith",
  "password": "N3w-P@ssw0rd"
}