Update a user

PUT 
<your-unleash-url>/api/admin/user-admin/:id

Only the explicitly specified fields get updated.

Request

Path Parameters

id integerrequired

a user id

application/json

Bodyrequired

updateUserSchema

emailstring
The user's email address. Must be provided if username is not provided.
Example: user@example.com
namestring
The user's name (not the user's username).
Example: Sam Seawright
rootRole object
The role to assign to the user. Can be either the role's ID or its unique name.
oneOf
MOD1
integer
Example: 1
MOD2
string
Possible values: [Admin, Editor, Viewer, Owner, Member]
Example: Admin

Responses

200

createUserResponseSchema

application/json

Schema

Schema

idintegerrequired
The user id
Example: 123
isAPIbooleandeprecated
Deprecated in v5. Used internally to know which operations the user should be allowed to perform
Example: true
namestringnullable
Name of the user
Example: User
emailstring
Email of the user
Example: user@example.com
usernamestringnullable
A unique username for the user
Example: hunter
imageUrlstring
URL used for the user profile image
Example: https://example.com/242x200.png
inviteLinkstring
If the user is actively inviting other users, this is the link that can be shared with other users
Example: http://localhost:4242/invite-link/some-secret
loginAttemptsinteger
How many unsuccessful attempts at logging in has the user made
Example: 3
emailSentboolean
Is the welcome email sent to the user or not
Example: false
rootRole object
Which root role this user is assigned. Usually a numeric role ID, but can be a string when returning newly created user with an explicit string role.
oneOf
MOD1
integer
Example: 1
MOD2
string
Possible values: [Admin, Editor, Viewer, Owner, Member]
Example: Admin
seenAtdate-timenullable
The last time this user logged in
Example: 2023-06-30T11:42:00.345Z
createdAtdate-time
The user was created at this time
Example: 2023-06-30T11:41:00.123Z
accountTypestring
A user is either an actual User or a Service Account
Example: User
permissionsstring[]
Deprecated
scimIdstringnullable
The SCIM ID of the user, only present if managed by SCIM
Example: 01HTMEXAMPLESCIMID7SWWGHN6
activeSessionsintegernullable
Count of active browser sessions for this user
Example: 2
deletedSessionsnumber
Experimental. The number of deleted browser sessions after last login
Example: 1

Example (auto)

{
  "id": 123,
  "name": "User",
  "email": "user@example.com",
  "username": "hunter",
  "imageUrl": "https://example.com/242x200.png",
  "inviteLink": "http://localhost:4242/invite-link/some-secret",
  "loginAttempts": 3,
  "emailSent": false,
  "rootRole": 1,
  "seenAt": "2023-06-30T11:42:00.345Z",
  "createdAt": "2023-06-30T11:41:00.123Z",
  "accountType": "User",
  "permissions": [
    "string"
  ],
  "scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
  "activeSessions": 2,
  "deletedSessions": 1
}

400

The request data does not match what we expect.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: ValidationError
messagestring
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NoAccessError
messagestring
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

404

The requested resource was not found.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NotFoundError
messagestring
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT '<your-unleash-url>/api/admin/user-admin/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
--data-raw '{
  "email": "user@example.com",
  "name": "Sam Seawright",
  "rootRole": 1
}'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

id — pathrequired

Body required

{
  "email": "user@example.com",
  "name": "Sam Seawright",
  "rootRole": 1
}

ResponseClear

Click the Send API Request button above and see the response here!