Site Home
API Reference
LoginTry for Free

Patch Identity Provider

patch
https://{application_vanity_domain}/api/v1/identity-providers/
Path Params
string
required
length between 1 and 26

The ID of the identity provider that the resource or action is scoped to.

Body Params

JSON object adhering to the JSON merge patch specification.

string
string
enum
required
length between 1 and 30

[Required on Create and Upsert] The type of the owner of the resource.

Allowed:
string
required
length between 1 and 26

[Required on Create and Upsert] The ID of the owner of the resource.

string
enum
required
length between 1 and 25

The type of the IdP

string
length between 1 and 70

[Required on Upsert] The name of the IdP. For enterprise IDPs this value must be provided on creation; however, for non-enterprise IDPs this value will be defaulted based on the identity provider type.

string
length between 1 and 20

The display name of the IdP. For enterprise IDPs this value must be provided on creation; however, for non-enterprise IDPs this value wil be defaulted based on the identity provider type.

string
enum
length between 1 and 45
Defaults to ENABLED

The status of the IdP

Allowed:
string
loginIdentifiers
array of strings
length ≥ 1

Array of primary identifiers that can be used to uniquely identify a user in this Wristband IdP

loginFactors
array of strings
length ≥ 1

Array of primary factors that can be used to log a user in for this Wristband IdP

string
enum
length between 1 and 30

The first login factor that will be shown on the login page or other authentication flows. This value must be one of the login factors included in the loginFactors field.

Allowed:
Headers
string
length ≥ 1

Used to perform a conditional update

Responses

Updated 6 months ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago