BEbeyondidentity
Authenticator Configurations

Create a New Authenticator Configuration

Changed on

To create an authenticator configuration, send a POST request to /v1/tenants/$TENANT_ID/realms/$REALM_ID/authenticator-configs. Values in the request body for read-only fields will be ignored.

post/v1/tenants/{tenant_id}/realms/{realm_id}/authenticator-configs

Request

Path parameters

tenant_idstring required
Example:000176d94fd7b4d1

A unique identifier for a tenant.

realm_idstring required
Example:19a95130480dfa79

A unique identifier for a realm.

Request body

Example request

{
  "authenticator_config": {
    "id": "73731b7f-eb76-4143-9b4b-81a720385f5a",
    "realm_id": "caf2ff640497591a",
    "tenant_id": "00011f1183c67b69",
    "display_name": "Pet Authenticator Configuration",
    "config": {
      "invoke_url": "http://localhost:8092",
      "trusted_origins": [
        "http://localhost:8092"
      ]
    }
  }
}

Response

The response will be a JSON object containing the standard attributes associated with an authenticator configuration.

idstring

A unique identifier for an authenticator configuration. This is automatically generated on creation. This field is immutable and read-only. This field is unique within the realm.

realm_idstring

A unique identifier for the authenticator configuration's realm. This is automatically set on creation. This field is immutable and read-only.

tenant_idstring

A unique identifier for the authenticator configuration's tenant. This is automatically set on creation. This field is immutable and read-only.

display_namestring

A human-readable name for the authenticator configuration. This name is used for display purposes.

Example response

{
  "id": "73731b7f-eb76-4143-9b4b-81a720385f5a",
  "realm_id": "caf2ff640497591a",
  "tenant_id": "00011f1183c67b69",
  "display_name": "Pet Authenticator Configuration",
  "config": {
    "invoke_url": "http://localhost:8092",
    "trusted_origins": [
      "http://localhost:8092"
    ]
  }
}

Changes

  • 42f3cac49392Revision changes
    • breaking

      added subschema #3: Console Authenticator subschema #4: Platform Authenticator to the response property oneOf list for the response status

    • info

      added subschema #3: Console Authenticator subschema #4: Platform Authenticator to the / request property oneOf list