Sign in
providers

OAuth2Provider Viewset

put/providers/oauth2/{id}/

Path parameters

idinteger required

A unique integer value identifying this OAuth2/OpenID Provider.

Request body

namestring required
authentication_flowstring uuid nullable

Flow used for authentication when the associated application is accessed by an un-authenticated user.

authorization_flowstring uuid required

Flow used when authorizing this provider.

invalidation_flowstring uuid required

Flow used ending the session from a provider.

property_mappingsstring[]
client_type'confidential' | 'public'
grant_typesGrantTypeEnum[]
client_idstring
client_secretstring
access_code_validitystring

Access codes not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).

access_token_validitystring

Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).

refresh_token_validitystring

Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).

refresh_token_thresholdstring

When refreshing a token, if the refresh token is valid for less than this duration, it will be renewed. When set to seconds=0, token will always be renewed. (Format: hours=1;minutes=2;seconds=3).

include_claims_in_id_tokenboolean

Include User claims from scopes in the id_token, for applications that don't access the userinfo endpoint.

signing_keystring uuid nullable

Key used to sign the tokens.

encryption_keystring uuid nullable

Key used to encrypt the tokens. When set, tokens will be encrypted and returned as JWEs.

logout_uristring uri
logout_method'backchannel' | 'frontchannel'
sub_mode'hashed_user_id' | 'user_id' | 'user_uuid' | 'user_username' | 'user_email' | 'user_upn'
issuer_mode'global' | 'per_provider'
jwt_federation_sourcesstring[]
jwt_federation_providersinteger[]

Response

pkinteger required
namestring required
authentication_flowstring uuid nullable

Flow used for authentication when the associated application is accessed by an un-authenticated user.

authorization_flowstring uuid required

Flow used when authorizing this provider.

invalidation_flowstring uuid required

Flow used ending the session from a provider.

property_mappingsstring[]
componentstring required

Get object component so that we know how to edit the object

assigned_application_slugstring nullable required

Internal application name, used in URLs.

assigned_application_namestring nullable required

Application's display Name.

assigned_backchannel_application_slugstring nullable required

Internal application name, used in URLs.

assigned_backchannel_application_namestring nullable required

Application's display Name.

verbose_namestring required

Return object's verbose_name

verbose_name_pluralstring required

Return object's plural verbose_name

meta_model_namestring required

Return internal model name

client_type'confidential' | 'public'
grant_typesGrantTypeEnum[]
client_idstring
client_secretstring
access_code_validitystring

Access codes not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).

access_token_validitystring

Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).

refresh_token_validitystring

Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).

refresh_token_thresholdstring

When refreshing a token, if the refresh token is valid for less than this duration, it will be renewed. When set to seconds=0, token will always be renewed. (Format: hours=1;minutes=2;seconds=3).

include_claims_in_id_tokenboolean

Include User claims from scopes in the id_token, for applications that don't access the userinfo endpoint.

signing_keystring uuid nullable

Key used to sign the tokens.

encryption_keystring uuid nullable

Key used to encrypt the tokens. When set, tokens will be encrypted and returned as JWEs.

logout_uristring uri
logout_method'backchannel' | 'frontchannel'
sub_mode'hashed_user_id' | 'user_id' | 'user_uuid' | 'user_username' | 'user_email' | 'user_upn'
issuer_mode'global' | 'per_provider'
jwt_federation_sourcesstring[]
jwt_federation_providersinteger[]

Changes

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