Skip to content
Authrim

List field catalogs.

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

Lists field catalogs and their active version summaries, including catalog entries available for identity mapping.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Field catalog list response.

Media type application/json
object
catalogs
required
Array<object>
object
id
required
string
tenantId
required
string
catalogKey
required
string
displayName
required
string
lifecycleState
required
string
versionId
string | null
versionLabel
string | null
bundleHash
string | null
entries
Array<object>
object
id
required
string
stableFieldId
string
namespace
required
string
path
required
string
targetTaxonomy
string
valueType
required
string
cardinality
required
string
classification
required
string
aliases
Array<string>
uiGroupKey
string | null
uiGroupLabel
string | null
uiGroupOrder
integer
uiFieldOrder
integer
examples
Array
note
string | null
key
additional properties
key
additional properties
key
additional properties
Example generated
{
  "catalogs": [
    {
      "id": "example",
      "tenantId": "example",
      "catalogKey": "example",
      "displayName": "example",
      "lifecycleState": "example",
      "versionId": "example",
      "versionLabel": "example",
      "bundleHash": "example",
      "entries": [
        {
          "id": "example",
          "stableFieldId": "example",
          "namespace": "example",
          "path": "example",
          "targetTaxonomy": "example",
          "valueType": "example",
          "cardinality": "example",
          "classification": "example",
          "aliases": [
            "example"
          ],
          "uiGroupKey": "example",
          "uiGroupLabel": "example",
          "uiGroupOrder": 1,
          "uiFieldOrder": 1,
          "examples": [
            "example"
          ],
          "note": "example"
        }
      ]
    }
  ]
}

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"
}