Get Current User

Get Current User

Using this method, one can look up the details of a user initiated this API method.


Note: The provided hrefs are functional for the users with 'administration.accesscontrol.viewpage' (View Access Control Page) privilege.

Request
URI
GET
https://{api_host}/suite-api/api/auth/currentuser
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Details of the user initiated this API method

Returns user of type(s) application/json 
"No Custom Example is Available"
string As uuid As uuid
id
Optional

Identifier of the user in the system.

string As ^[^\s,<&"'?+%=>;/#]+$
username
Required

Username of the current user.

string
firstName
Optional

First name of the current user.

string
lastName
Optional

The last name of the current user.

string
password
Required

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

string
emailAddress
Optional

The email address of the current user

string
distinguishedName
Optional

distinguished name of the current user.

boolean
enabled
Optional

Is the current user's account enabled?

array of string
groupIds
Optional

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

array of string
roleNames
Optional

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

array of object
role-permissions
Optional

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

integer As int64 As int64
lastLoginTime
Optional

Last login time

string
externalId
Optional

External ID of vIDB user. This field is only used in vIDB user import flow. It will not be populated for any other scenarios. Please note, this field may be removed in future.

array of object
links
Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/auth/currentuser
On This Page
Auth Operations
GET
Get Users
PUT
Modify User
POST
Create User
DELETE
Delete Users
PUT
Assign Traversal Spec To User
Deprecated
GET
Get Assigned Role Permissions For User
PUT
Assign Role Permission To User
PUT
Change Password
GET
Get User Groups
PUT
Modify User Group
POST
Create User Group
DELETE
Delete User Groups
PUT
Assign Traversal Spec To User Group
Deprecated
GET
Get Assigned Role Permissions For User Group
PUT
Assign Role Permission To User Group
GET
Get Auth Sources
PUT
Update Auth Source
POST
Add Auth Source
PATCH
Patch Auth Source With Certificate Details
PUT
Synchronize User Groups
GET
Get All Object Scopes
PUT
Modify Scope
POST
Create Scope
DELETE
Delete Scopes
GET
Get Roles
PUT
Update User Role
POST
Create User Role
GET
Get Role Privileges
PUT
Set Role Privileges
POST
Add Role Privileges
DELETE
Remove Role Privileges
POST
Release Token
POST
Acquire Token
POST
Import Users
POST
Search Users For Auth Source
POST
Search User Groups For Auth Source
POST
Test Auth Source
PATCH
Patch Test Auth Source
GET
Get User
DELETE
Delete User
GET
Get User Group
DELETE
Delete User Group
GET
Get Traversal Specs
GET
Get Auth Source Types
GET
Get Auth Source Type
GET
Get Auth Source
DELETE
Delete Auth Source
GET
Get Scope
GET
Get Role By Name
DELETE
Delete User Role
GET
Get Available Privileges
GET
Get Available Privilege Groups
GET
Get Current User
GET
Get Current User Role Privileges
GET
Get Assigned Role Permissions For Current User
DELETE
Unassigned Role Permission From User
DELETE
Unassigned Role Permission From User Group