Modify User Using PUT

Modify User Using PUT

Modify the details of a particular user

Request
URI
PUT
https://{api_host}/api/auth/users
COPY
Request Body

The user object that is being modified

user of type(s) application/json
Required

Show optional properties

{
    "password": "string",
    "username": "string"
}
{
    "distinguishedName": "string",
    "emailAddress": "string",
    "enabled": false,
    "firstName": "string",
    "groupIds": [
        "string"
    ],
    "id": "string",
    "lastLoginTime": 0,
    "lastName": "string",
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "password": "string",
    "role-permissions": [
        {
            "allowAllObjects": false,
            "links": [
                {
                    "description": "string",
                    "href": "string",
                    "name": "string",
                    "rel": "string"
                }
            ],
            "roleName": "string",
            "scopeId": "string",
            "traversal-spec-instances": [
                {
                    "adapterKind": "string",
                    "includedAdapterKinds": [
                        "string"
                    ],
                    "name": "string",
                    "resourceKind": "string",
                    "resourceSelection": [
                        {
                            "resourceId": [
                                "string"
                            ],
                            "type": "string"
                        }
                    ],
                    "selectAllResources": false
                }
            ]
        }
    ],
    "roleNames": [
        "string"
    ],
    "username": "string"
}
string
distinguishedName
Optional

distinguished name of the current user.

string
emailAddress
Optional

The email address of the current user

boolean
enabled
Optional

Is the current user's account enabled?

string
firstName
Optional

First name of the current user.

array of string
groupIds
Optional

The list of group ids to which the current user belongs to.

string As uuid As uuid
id
Optional

Identifier of the user in the system.

integer As int64 As int64
lastLoginTime
Optional

Last login time

string
lastName
Optional

The last name of the current user.

array of link
links
Optional

links

string
password
Required

Password of the user object. When creating a new local user, this field has to be specified.

array of role-permission
role-permissions
Optional

List of role permissions assigned to this user. May be null. Replaces and takes precedence over roleNames

array of string
roleNames
Optional

(Deprecated) List of role names assigned to the user. May be null.

string
username
Required

Username of the current user.

Authentication
This operation uses the following authentication methods.
Responses
200

The modified user object

Returns user of type(s) application/json 
{
    "distinguishedName": "string",
    "emailAddress": "string",
    "enabled": false,
    "firstName": "string",
    "groupIds": [
        "string"
    ],
    "id": "string",
    "lastLoginTime": 0,
    "lastName": "string",
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "password": "string",
    "role-permissions": [
        {
            "allowAllObjects": false,
            "links": [
                {
                    "description": "string",
                    "href": "string",
                    "name": "string",
                    "rel": "string"
                }
            ],
            "roleName": "string",
            "scopeId": "string",
            "traversal-spec-instances": [
                {
                    "adapterKind": "string",
                    "includedAdapterKinds": [
                        "string"
                    ],
                    "name": "string",
                    "resourceKind": "string",
                    "resourceSelection": [
                        {
                            "resourceId": [
                                "string"
                            ],
                            "type": "string"
                        }
                    ],
                    "selectAllResources": false
                }
            ]
        }
    ],
    "roleNames": [
        "string"
    ],
    "username": "string"
}
string
distinguishedName
Optional

distinguished name of the current user.

string
emailAddress
Optional

The email address of the current user

boolean
enabled
Optional

Is the current user's account enabled?

string
firstName
Optional

First name of the current user.

array of string
groupIds
Optional

The list of group ids to which the current user belongs to.

string As uuid As uuid
id
Optional

Identifier of the user in the system.

integer As int64 As int64
lastLoginTime
Optional

Last login time

string
lastName
Optional

The last name of the current user.

array of link
links
Optional

links

string
password
Required

Password of the user object. When creating a new local user, this field has to be specified.

array of role-permission
role-permissions
Optional

List of role permissions assigned to this user. May be null. Replaces and takes precedence over roleNames

array of string
roleNames
Optional

(Deprecated) List of role names assigned to the user. May be null.

string
username
Required

Username of the current user.


On This Page
Auth Operations
POST
Add Role Privileges Using POST
PUT
Assign Role Permission To User Group Using PUT
PUT
Assign Role Permission To User Using PUT
POST
Create Scope Using POST
POST
Create User Group Using POST
POST
Create User Role Using POST
DELETE
Delete Scopes Using DELETE
DELETE
Delete User Groups Using DELETE
DELETE
Delete User Group Using DELETE
DELETE
Delete User Role Using DELETE
GET
Get All Object Scopes Using GET
GET
Get Assigned Role Permissions For Current User Using GET
GET
Get Assigned Role Permissions For User Group Using GET
GET
Get Assigned Role Permissions For User Using GET
GET
Get Auth Sources Using GET
GET
Get Auth Source Types Using GET
GET
Get Auth Source Type Using GET
GET
Get Auth Source Using GET
GET
Get Available Privilege Groups Using GET
GET
Get Available Privileges Using GET
GET
Get Current User Role Privileges Using GET
GET
Get Current User Using GET
GET
Get Role By Name Using GET
GET
Get Role Privileges Using GET
GET
Get Roles Using GET
GET
Get Scope Using GET
GET
Get Traversal Specs Using GET
GET
Get User Groups Using GET
GET
Get User Group Using GET
GET
Get Users Using GET
GET
Get User Using GET
PUT
Modify Scope Using PUT
PUT
Modify User Group Using PUT
PUT
Modify User Using PUT
DELETE
Remove Role Privileges Using DELETE
PUT
Set Role Privileges Using PUT
PUT
Synchronize User Groups Using PUT
DELETE
Unassigned Role Permission From User Group Using DELETE
DELETE
Unassigned Role Permission From User Using DELETE
PUT
Update User Role Using PUT