1Get User
Overview
This API retrieves a User object, comprising details such as user roles, ID, email, etc.
Method: GET
Request URL: {kyvos-url}/rest/v2/users/{name-or-id}
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
sessionid | String | The session ID is the token received from the login API. Note: Session ID is required for token-based authentication. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
name-or-id (Required) | String | Name or ID of the User object to be retrieved. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id parameter should be interpreted as a User name or User ID. If by=name, provide the User name in the name-or-id parameter. If by=id, provide the User ID in the name-or-id parameter. The default value is name. | – |
Responses
200 Success
{
"patExist": false,
"preferences": {},
"userStatus": 0,
"roles": "0",
"userCreationMode": "0",
"description": "",
"provisionedBy": "API",
"isPasswordEncrypted": true,
"password": "",
"userAuthType": "LDAP",
"groupIds": "",
"generateSecret": false,
"name": "Admin",
"id": "97795232",
"userCustomAttributes": [],
"email": ""
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | Connection, database, schema, or table not found. |
500 | Internal Server Error |