Update an Access identity provider

PUT

https://api.cloudflare.com/client/v4/zones/{identifier}/access/identity_providers/{uuid}

Last modified:2022-12-16 13:48:36

Updates a configured identity provider.

Request

Path Params

uuid

string

required

identifier

string

required

Body Params application/json

config

object (schemas-config)

required

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

name

string

required

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

Example:

Widget Corps OTP

type

string

required

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

Example:

onetimepin

Example

{
    "config": {},
    "name": "Widget Corps OTP",
    "type": "onetimepin"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/zones//access/identity_providers/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "config": {},
    "name": "Widget Corps OTP",
    "type": "onetimepin"
}'

Responses

🟢200Update an Access identity provider response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object (Cloudflare Client API_identity-providers)

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "config": {},
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "name": "Widget Corps OTP",
        "type": "onetimepin"
    },
    "success": true
}

🟢200Update an Access identity provider response failure

Modified at 2022-12-16 13:48:36

Get an Access identity provider

List mTLS certificates