Get User

Get User

Retrieve user details.

Request
URI
GET
https://{api_host}/https://{{host}}:{{port}}/api/v5/rbac/{instanceName}/users/{userName}
COPY
Path Parameters
string
userName
Required

User name.

string
instanceName
Required

Instance name.

Responses
200

Get user.

Returns User of type(s) */* 
{
    "id": "string",
    "uid": "string",
    "authInstanceName": "string",
    "fullName": "string",
    "email": "string",
    "userMetaData": {
        "userMetaData": [
            "string"
        ]
    },
    "role": {
        "id": "string",
        "name": "string",
        "permissions": [
            {
                "name": "string"
            }
        ]
    },
    "memberOf": [
        "string"
    ]
}
string
id
Optional

id

string
uid
Required

uid

string
authInstanceName
Required

authInstanceName

string
fullName
Optional

fullName

string
email
Optional

email

object
userMetaData
Optional

userMetaData

Role
role
Optional

Role object.

array of string
memberOf
Optional

memberOf


401

Unauthorized access

Returns User of type(s) */* 
{
    "id": "string",
    "uid": "string",
    "authInstanceName": "string",
    "fullName": "string",
    "email": "string",
    "userMetaData": {
        "userMetaData": [
            "string"
        ]
    },
    "role": {
        "id": "string",
        "name": "string",
        "permissions": [
            {
                "name": "string"
            }
        ]
    },
    "memberOf": [
        "string"
    ]
}
string
id
Optional

id

string
uid
Required

uid

string
authInstanceName
Required

authInstanceName

string
fullName
Optional

fullName

string
email
Optional

email

object
userMetaData
Optional

userMetaData

Role
role
Optional

Role object.

array of string
memberOf
Optional

memberOf


404

Such resource was not found.

Returns User of type(s) */* 
{
    "id": "string",
    "uid": "string",
    "authInstanceName": "string",
    "fullName": "string",
    "email": "string",
    "userMetaData": {
        "userMetaData": [
            "string"
        ]
    },
    "role": {
        "id": "string",
        "name": "string",
        "permissions": [
            {
                "name": "string"
            }
        ]
    },
    "memberOf": [
        "string"
    ]
}
string
id
Optional

id

string
uid
Required

uid

string
authInstanceName
Required

authInstanceName

string
fullName
Optional

fullName

string
email
Optional

email

object
userMetaData
Optional

userMetaData

Role
role
Optional

Role object.

array of string
memberOf
Optional

memberOf


504

Connection timed out.

Returns User of type(s) */* 
{
    "id": "string",
    "uid": "string",
    "authInstanceName": "string",
    "fullName": "string",
    "email": "string",
    "userMetaData": {
        "userMetaData": [
            "string"
        ]
    },
    "role": {
        "id": "string",
        "name": "string",
        "permissions": [
            {
                "name": "string"
            }
        ]
    },
    "memberOf": [
        "string"
    ]
}
string
id
Optional

id

string
uid
Required

uid

string
authInstanceName
Required

authInstanceName

string
fullName
Optional

fullName

string
email
Optional

email

object
userMetaData
Optional

userMetaData

Role
role
Optional

Role object.

array of string
memberOf
Optional

memberOf


On This Page
Rbac Operations
POST
Add Ad Settings
POST
Add Ldap Settings
POST
Add New Group
POST
Add New User
POST
Create Role
DELETE
Delete Group For Instance
DELETE
Delete Ldap Settings
DELETE
Delete Role
DELETE
Delete User
GET
Get All Groups
GET
Get All Ldap Settings
GET
Get All Users
GET
Get All Users Per Instance
GET
Get Group
GET
Get Ldap Setting
GET
Get Ldap Settings
GET
Get Role
GET
Get Roles
GET
Get User
PUT
Modify Group Role
PUT
Modify User Role
POST
Query User
POST
Test Connection
PUT
Update Ldap Settings
PUT
Update Role