Get federated group mapping

GET

/api/v1/federation/group-mappings/{id}

const url = 'http://localhost:3000/api/v1/federation/group-mappings/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/api/v1/federation/group-mappings/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Retrieves a single federated group mapping. Requires Super Admin privileges.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

Mapping UUID

Responses

200

Mapping retrieved successfully

application/json

object

required

Unique mapping identifier

string format: uuid

organizationId

required

Organization the mapping grants membership in

string format: uuid

provider

required

Identity provider that supplies the app-role / group

string

Allowed values: ENTRA LDAP

externalId

required

Provider role value or group id carried in the token claim

string

externalKind

required

Kind of external identifier (application role or group)

string

Allowed values: APP_ROLE GROUP

externalLabel

Human-readable label captured at mapping time

string

roleId

required

WFM role granted to users matching this mapping

string format: uuid

enabled

required

Whether the mapping is active (resolved at login time)

boolean

createdById

Id of the user who created the mapping

string format: uuid

createdAt

required

When the mapping was created

string format: date-time

updatedAt

required

When the mapping was last updated

string format: date-time

Example

{
  "id": "550e8400-e29b-41d4-a716-446655440002",
  "organizationId": "550e8400-e29b-41d4-a716-446655440000",
  "provider": "ENTRA",
  "externalId": "fleet-operators",
  "externalKind": "APP_ROLE",
  "externalLabel": "Fleet Operators (Entra group)",
  "roleId": "550e8400-e29b-41d4-a716-446655440001",
  "enabled": true,
  "createdById": "550e8400-e29b-41d4-a716-446655440003",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-06-20T14:45:00Z"
}

401

Unauthorized

403

Forbidden - Super Admin required

404

Mapping not found