BEbeyondidentity
Authenticator Configurations

List Authenticator Configurations for a Realm

Changed on

To list all authenticator configurations for a realm, send a GET request to /v1/tenants/$TENANT_ID/realms/$REALM_ID/authenticator-configs.

The response will contain at most 100 items and may contain a page token to query the remaining items. If page size is not specified, the response will contain 100 items. There is no defined ordering of the list of authenticator configurations in the response. Note that the maximum and default page sizes are subject to change.

When paginating, the page size is maintained by the page token but may be overridden on subsequent requests. The skip is not maintained by the page token and must be specified on each subsequent request.

Page tokens expire after one week. Requests which specify an expired page token will result in undefined behavior.

get/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.

Query parameters

page_sizeinteger

Number of items returned per page. The response will include at most this many results but may include fewer. If this value is omitted, the response will return the default number of results allowed by the method.

page_tokenstring

Token to retrieve the subsequent page of the previous request. All other parameters to the list endpoint should match the original request that provided this token unless otherwise specified.

filterstring

Filter to constrain the response. The response will only include resources matching this filter. Filters follow the SCIM grammar from RFC-7644 Section 3.4.2.2.

Response

The response will be a JSON object with a keys for authenticator_configs and total_size. authenticator_configs will be set to an array of authenticator configuration objects, each of which contains the standard authenticator configuration attributes. total_size will be set to the total number of items matched by the list request. If there are more items to be returned by the requested query, the response will also contain a key called next_page_token.

total_sizeinteger required

Total number of results returned by the operation. This value may be larger than the number of resources returned, such as when returning a single page where multiple pages are available.

next_page_tokenstring

Token used to fetch the next set of results. If this field is omitted, there are no subsequent pages.

Example response

{
  "authenticator_configs": [
    {
      "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"
        ]
      }
    }
  ],
  "total_size": 1000
}

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 the new optional query request parameter filter