Skip to main content
PATCH
/
api
/
identity-providers
/
{alias}
/
toggle
Enable or disable identity provider
curl --request PATCH \
  --url https://api.example.com/api/identity-providers/{alias}/toggle \
  --header 'Authorization: Bearer <token>'
{
  "alias": "<string>",
  "display_name": "<string>",
  "provider_id": "<string>",
  "enabled": true,
  "internal_id": "<string>",
  "config": {},
  "mapper_count": 0
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
alias
string
required

Query Parameters

​
enabled
boolean
required

True to enable or False to disable.

Response

Identity provider toggled.

Response for a single identity provider.

​
alias
string
required
​
display_name
string
required
​
provider_id
string
required
​
enabled
boolean
required
​
internal_id
string | null
​
known_provider
enum<string> | null
Available options:
okta,
entra_id,
auth0,
google,
github,
ping_identity,
onelogin,
custom_oidc,
custom_saml,
active_directory
​
config
Config · object

Provider configuration. NexusOne masks the secrets.

​
mapper_count
integer
default:0

Number of configured mappers.