API Reference
Start typing to search…

Get user

get https://{host}/platform/security/v1/users/

Returns the specified user.

A user is a principal -- an API key or licensed human user account. Principals gain access rights and permissions to protected resources by being members of a user group that has been granted those access rights and permissions.

A user is identifed by a username, which is usually unique login ID, i.e. name@company.com.

Path Params
string
required
Responses

Response body
object
string

Name of user.

string

Status of user.

string

Type of user.

User Apikey

userDetails
object

Detailed information about user.

string
string
string

Last name of user.

string

First name of user.

string

Email address of user, e.g. name@company.com.

string
date-time | null
groups
array of objects

List of user groups.

groups
object
string

Name of group.

string

ID of group.

string

Status of group.

enabled disabled

Updated 5 months ago

Did this page help you?
Language
Credentials
URL
Request

Updated 5 months ago

Did this page help you?