Skip to main content

List groups and roles you can select across platforms

GET 
/api/v1/GroupRole/candidates

Returns a combined, paged list of Active Directory groups, Entra ID groups and directory roles, and SQL Server and Oracle database roles. Use it to choose a group or role for an access policy or similar setting. Entra ID directory roles appear only for tenants that have a service account configured, and an Entra tenant whose roles cannot be read is skipped without an error. Deleted Active Directory groups and groups in domains linked to an Entra ID tenant are left out.

Permission required: Administrator role or application role.

Request​

Responses​

An object with a data array of candidates and a recordsTotal count of all matches before paging. Each item has id, name, type, platformId, platformName, context and additionalInfo, plus hostId, hostDatabaseId, domainId or tenantId where they apply.