Get a group or role by ID

GET 
/api/v1/GroupRole/:id

Returns one group or role from any supported platform. The ID can belong to a SQL Server or Oracle database role, an Entra ID group, or an on-premises Active Directory group. Entra ID directory roles listed by the candidates route cannot be fetched by ID.

Permission required: Administrator role or application role.

Request

Responses

200

The group or role. Each item has id, name, type, platformId, platformName, context and additionalInfo, plus hostId, hostDatabaseId, domainId or tenantId where they apply.

404

No group or role has that ID. The response includes an error and the ID.

500

The lookup failed. The response includes an error and message.