Org authentication configs

Update auth config.

Update an authentication configuration for the API.

put/api_auth_configs/{auth_config_id}

Request

Path parameters

auth_config_idinteger required

The unique ID of the organization that needs to be updated.

Request body

idinteger
owner_idinteger
org_idinteger
uidstring
protocolstring
namestring
descriptionstring
globalboolean
enabled_by_defaultboolean
auto_create_users_enabledboolean
name_identifier_formatstring
nexla_base_urlstring
service_entity_idstring
assertion_consumer_urlstring
idp_entity_idstring
idp_sso_target_urlstring
idp_slo_target_urlstring
idp_certstring
security_settingsobject
metadatastring
oidc_domainstring
oidc_keys_url_keystring
oidc_id_claimsobject
oidc_access_claimsobject
client_configobject
secret_configobject
check_stateboolean

Response

Success

idinteger
uidstring

Unique external identifier for the authentication configuration.

protocol'saml' | 'oidc' | 'google' | 'password'
namestring
descriptionstring
globalboolean

If true, this configuration is available to all organizations in the environment.

auto_create_users_enabledboolean

If true, Nexla will automatically create users in the environment when they log in using this authentication configuration.

name_identifier_formatstring

The format of the NameID element in the SAML assertion. This is used to identify the user.

nexla_base_urlstring

The base URL of the Nexla environment where the user should be redirected after authentication.

service_entity_idstring
assertion_consumer_urlstring
logout_urlstring
metadata_urlstring
idp_entity_idstring
idp_sso_target_urlstring
idp_slo_target_urlstring
idp_certstring
security_settingsstring
oidc_domainstring
oidc_keys_url_keystring
oidc_token_verify_urlstring
oidc_id_claimsstring
oidc_access_claimsstring
client_configobject
updated_atstring date-time
created_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.