Get User By Id

Get User By Id

API returns user in keycloak for given user id

Request
URI
GET
https://{api_host}/tcsa.host.com/tcsa/api/auth-management/v1/users/{id}
COPY
Path Parameters
string
id
Required

user id of the user to be returned

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns KeycloakGetUser of type(s) application/json 
{
    "id": "ee8a4feb-2c32-44a2-98ad-5b6ae352d5e3",
    "createdTimestamp": 1707472126528,
    "username": "user1",
    "enabled": true,
    "emailVerified": false,
    "disableableCredentialTypes": [],
    "requiredActions": [],
    "federatedIdentities": [],
    "notBefore": 0,
    "access": {
        "manageGroupMembership": true,
        "view": true,
        "mapRoles": true,
        "impersonate": false,
        "manage": true
    }
}
string
id
Optional

user id

number
createdTimestamp
Optional

user created time

string
username
Optional

username of the user

string
firstName
Optional

firstName of the user

string
lastName
Optional

lastName of the user

boolean
enabled
Optional

enabled

boolean
emailVerified
Optional

email verified

array of string
disableableCredentialTypes
Optional

array of disableable Credential Types

array of string
requiredActions
Optional

array of requiredActions

number
notBefore
Optional

not Before

object
attributes
Optional

contains all attributes of group

array of string
realmRoles
Optional

array of realm roles

object
clientRoles
Optional

contains all client roles

object
access
Optional

contails access permissions of the group

array of string
groups
Optional

contains the group info

string
email
Optional

email of the user

string
origin
Optional

origin of the user

string
self
Optional

self of the user


400

Invalid Request sent by the user

Returns KeycloakErrorDetails of type(s) application/json 
{
    "error": "string"
}
string
error
Optional

Error message from keycloak


401

User authentication failed

Returns KeycloakErrorDetails of type(s) application/json 
{
    "error": "string"
}
string
error
Optional

Error message from keycloak


403

Access to the requested resource/operation is forbidden

Returns KeycloakErrorDetails of type(s) application/json 
{
    "error": "string"
}
string
error
Optional

Error message from keycloak


404

Cannot find requested resource

Returns KeycloakErrorDetails of type(s) application/json 
{
    "error": "string"
}
string
error
Optional

Error message from keycloak


500

Internal server error

Returns KeycloakErrorDetails of type(s) application/json 
{
    "error": "string"
}
string
error
Optional

Error message from keycloak


On This Page
User Management Operations
POST
Create Group
POST
Create User
DELETE
Delete Group
DELETE
Delete User
GET
Get All User Groups
GET
Get Group By Id
GET
Get Groups
GET
Get Group Users
GET
Get User By Id
GET
Get Users
GET
Groups Count
PUT
Update Group
PUT
Update User
GET
Users Count
PUT
User To Group Mapping