OAuth2Provider.md

OAuth2Provider

OAuth2Provider Serializer

Properties

Name	Type	Description	Notes
pk	int		[readonly]
name	str
authentication_flow	UUID	Flow used for authentication when the associated application is accessed by an un-authenticated user.	[optional]
authorization_flow	UUID	Flow used when authorizing this provider.
invalidation_flow	UUID	Flow used ending the session from a provider.
property_mappings	List[UUID]		[optional]
component	str	Get object component so that we know how to edit the object	[readonly]
assigned_application_slug	str	Internal application name, used in URLs.	[readonly]
assigned_application_name	str	Application's display Name.	[readonly]
assigned_backchannel_application_slug	str	Internal application name, used in URLs.	[readonly]
assigned_backchannel_application_name	str	Application's display Name.	[readonly]
verbose_name	str	Return object's verbose_name	[readonly]
verbose_name_plural	str	Return object's plural verbose_name	[readonly]
meta_model_name	str	Return internal model name	[readonly]
client_type	ClientTypeEnum	Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable	[optional]
client_id	str		[optional]
client_secret	str		[optional]
access_code_validity	str	Access codes not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).	[optional]
access_token_validity	str	Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).	[optional]
refresh_token_validity	str	Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).	[optional]
refresh_token_threshold	str	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).	[optional]
include_claims_in_id_token	bool	Include User claims from scopes in the id_token, for applications that don't access the userinfo endpoint.	[optional]
signing_key	UUID	Key used to sign the tokens.	[optional]
encryption_key	UUID	Key used to encrypt the tokens. When set, tokens will be encrypted and returned as JWEs.	[optional]
redirect_uris	List[RedirectURI]
logout_uri	str		[optional]
logout_method	OAuth2ProviderLogoutMethodEnum	Backchannel logs out with server to server calls. Frontchannel uses iframes in your browser	[optional]
sub_mode	SubModeEnum	Configure what data should be used as unique User Identifier. For most cases, the default should be fine.	[optional]
issuer_mode	IssuerModeEnum	Configure how the issuer field of the ID Token should be filled.	[optional]
jwt_federation_sources	List[UUID]		[optional]
jwt_federation_providers	List[int]		[optional]

Example

from authentik_client.models.o_auth2_provider import OAuth2Provider

# TODO update the JSON string below
json = "{}"
# create an instance of OAuth2Provider from a JSON string
o_auth2_provider_instance = OAuth2Provider.from_json(json)
# print the JSON string representation of the object
print(OAuth2Provider.to_json())

# convert the object into a dict
o_auth2_provider_dict = o_auth2_provider_instance.to_dict()
# create an instance of OAuth2Provider from a dict
o_auth2_provider_from_dict = OAuth2Provider.from_dict(o_auth2_provider_dict)

[Back to Model list] [Back to API list] [Back to README]