Skip to content
Authrim

List field-mapping attribute groups.

GET
/api/admin/field-mapping/attribute-groups
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/field-mapping/attribute-groups \
  --header 'Authorization: Bearer <token>'

Lists registered attribute groups for the tenant, including protocol, group type/key, display name, field keys, and lifecycle state.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Attribute group registry response.

Media type application/json
object
attributeGroups
required
Array<object>
object
id
required
string
tenantId
required
string
ownerScopeType
required
string
Allowed values: platform tenant
ownerScopeId
string | null
protocol
required
string
Allowed values: oidc saml vc
groupType
required
string
groupKey
required
string
displayName
required
string
description
string | null
fieldKeys
required
Array<string>
lifecycleState
required
string
key
additional properties
key
additional properties
Example 
{
  "attributeGroups": [
    {
      "id": "attribute_group_123",
      "tenantId": "default",
      "ownerScopeType": "tenant",
      "ownerScopeId": "default",
      "protocol": "oidc",
      "groupType": "profile",
      "groupKey": "workforce",
      "displayName": "Workforce profile",
      "description": "Claims released to workforce apps.",
      "fieldKeys": [
        "email",
        "department"
      ],
      "lifecycleState": "active"
    }
  ]
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}