Get Group By Id

Get Group By Id

API returns group in keycloak for given group id

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

Group id of the group to be returned

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns KeycloakGroup of type(s) application/json 
{
    "id": "46caf226-4918-4b1d-9f05-1a2d706a7d9e",
    "name": "Enterprise Administrator",
    "path": "/Enterprise Administrator",
    "attributes": {},
    "realmRoles": [],
    "clientRoles": {},
    "subGroups": [],
    "access": {
        "view": true,
        "manage": true,
        "manageMembership": true
    }
}
string
id
Optional

group id

string
name
Optional

name of the group

string
path
Optional

specifies path of group

array of object
subGroups
Optional

contains sub groups of group

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


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