REST API Reference Version 5.2.1.0Search

Report_user_details

POST v1/tokens/id/actions/report_user_details

Description

Reports the user details for this token.

Normal Response Codes

200

HTTP Error Codes

400 401 403 404 409 500 503

Request

Parameter Type JSON Type Description Mandatory
id NsObjectID string ID for the session token. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. true

JSON Request

            
                
        
         

Response

Type: NsTokenReportUserDetailsReturn

Member Type JSON Type Description
user_name NsUserName string User name for the session. String of up to 80 alphanumeric characters, beginning with a letter. For Active Directory users, it can include backslash (\), dash (-), period (.), underscore (_) and space. Example: 'user1', 'companydomain\user1'.
primary_group_id NsObjectID string The ID of the primary Active Directory user group the user belongs to. RBAC is granted based on this group. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
primary_group_name NsUserGroupName string The primary Active Directory user group the user belongs to. RBAC is granted based on this group. String of up to 64 uppercase or lowercase characters excluding ampersand, less than, greater than and ^/\[]:;|=,+*?;. Example: 'admin-group-24'.
group_count NsUnsignedLong number The number of Active Directory user groups the user belongs to. Unsigned 64-bit integer. Example: 1234.
role NsUserRoles string Role of the user. Possible values: 'administrator', 'poweruser', 'operator', 'guest'.
inactivity_timeout NsUnsignedLong number The amount of time that the user session is inactive before timing out. Unsigned 64-bit integer. Example: 1234.
user_id NsObjectID string Global Id of the user. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
groups NsUserGroupNames array The list of Active Directory groups the user belongs to. List of Active Directory groups the user belongs to.

JSON Response

            
        
{"data": {"username": "admin","primary_group": "","group_count": 0,"role": "administrator","groups": []}}