List Access identity providers

Lists all configured identity providers.

application/json

Body

result

required

Any of

allOf {2}

array[object (Cloudflare Client API_identity-providers) {4}]

allOf {2}

One of

array[object (Cloudflare Client API_identity-providers) {4}]

object

config

object

schemas-config

optional

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.

string

uuid

read-onlyoptional

UUID

<= 36 characters

Example:

f174e90a-fafe-4643-bbbc-4a0ed4fc8415

name

string

identity-providers_components-schemas-name

optional

The name of the identity provider, shown to users on the login page.

Example:

Widget Corps OTP

type

string

identity-providers_components-schemas-type

optional

The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.

Example:

onetimepin

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "config": {},
            "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
            "name": "Widget Corps OTP",
            "type": "onetimepin"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List Access identity providers

Request

Request samples

Responses