Update users
patch
https://{your_site_interface}/opa-hub/api/12.2.35/users
This operation will update users.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Nested Schema : userPatch
Type:
Show Source
object
-
adminRoles: array
adminRoles
An array of Administrator roles for this user.
-
email: string
The user email address.
-
fullName: string
The user full name.
-
password: string
(password)
The user password. Write-only property.
-
status: string
Default Value:
Enabled
Allowed Values:[ "Locked", "Disabled", "Enabled" ]
The user status. -
temporaryPassword: boolean
The user password is temporary and must be changed. Write-only property.
-
userName(required): string
The user identifier.
-
userType: string
Default Value:
User
Allowed Values:[ "User", "LocalAPIClient", "APIClient" ]
The type of user. -
workspaces: array
workspaces
The list of workspaces that the user has roles in.
Nested Schema : adminRoles
Type:
array
An array of Administrator roles for this user.
Show Source
-
Array of:
string
Allowed Values:
[ "Permissions Administrator", "Connections Administrator" ]
Nested Schema : workspaces
Type:
array
The list of workspaces that the user has roles in.
Show Source
Nested Schema : userWorkspacePatch
Type:
Show Source
object
-
name(required): string
The name of the Workspace
-
roles(required): array
roles
The list of roles that the user has in the workspace.
Nested Schema : roles
Type:
array
The list of roles that the user has in the workspace.
Show Source
-
Array of:
string
Allowed Values:
[ "Deploy Admin", "Policy Author", "Determinations API", "Chat Service", "Viewer" ]
Security
-
Authorization: apiKey
Type:
apiKey
Description:Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
-
oauth2_opa: oauth2
Type:
oauth2
Description:POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.
Response
Supported Media Types
- application/json
200 Response
The request was successfully completed.
Nested Schema : user
Type:
Show Source
object
-
adminRoles: array
adminRoles
An array of Administrator roles for this user.
-
email: string
The user email address.
-
fullName: string
The user full name.
-
lastLogin: string
(date-time)
The last login of the user.
-
linkedConnection: string
Read Only:
true
The connection which the user is linked to, if there is one, otherwise this property is not displayed. -
status: string
Default Value:
Enabled
Allowed Values:[ "Locked", "Disabled", "Enabled" ]
The user status. -
userName(required): string
The user identifier.
-
userType: string
Default Value:
User
Allowed Values:[ "User", "LocalAPIClient", "APIClient" ]
The type of user. -
workspaces(required): array
workspaces
The list of workspaces that the user has roles in.
Nested Schema : adminRoles
Type:
array
An array of Administrator roles for this user.
Show Source
-
Array of:
string
Allowed Values:
[ "Permissions Administrator", "Connections Administrator" ]
Nested Schema : workspaces
Type:
array
The list of workspaces that the user has roles in.
Show Source
Nested Schema : userWorkspace
Type:
Show Source
object
-
name: string
The name of the Workspace
-
roles: array
roles
The list of roles that the user has in the workspace.
Nested Schema : roles
Type:
array
The list of roles that the user has in the workspace.
Show Source
-
Array of:
string
Allowed Values:
[ "Deploy Admin", "Policy Author", "Determinations API", "Chat Service", "Viewer" ]