Skip to main content

providers_oauth2_list

GET 
/providers/oauth2/

OAuth2Provider Viewset

Request​

Query Parameters

    access_code_validity string
    access_token_validity string
    application uuid
    authorization_flow uuid
    client_id string
    client_type string

    Possible values: [confidential, public]

    Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable

    include_claims_in_id_token boolean
    issuer_mode string

    Possible values: [global, per_provider]

    Configure how the issuer field of the ID Token should be filled.

    name string
    ordering string

    Which field to use when ordering the results.

    page integer

    A page number within the paginated result set.

    page_size integer

    Number of results to return per page.

    property_mappings uuid[]
    refresh_token_validity string
    search string

    A search term.

    signing_key uuid
    sub_mode string

    Possible values: [hashed_user_id, user_email, user_id, user_upn, user_username, user_uuid]

    Configure what data should be used as unique User Identifier. For most cases, the default should be fine.

Responses​

Schema

    pagination

    object

    required

    next numberrequired
    previous numberrequired
    count numberrequired
    current numberrequired
    total_pages numberrequired
    start_index numberrequired
    end_index numberrequired

    results

    object[]

    required

  • Array [

    • pk ID (integer)required
    name stringrequired
    authentication_flow uuidnullable

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

    authorization_flow uuidrequired

    Flow used when authorizing this provider.

    property_mappings uuid[]
    component stringrequired

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

    assigned_application_slug stringrequired

    Internal application name, used in URLs.

    assigned_application_name stringrequired

    Application's display Name.

    assigned_backchannel_application_slug stringrequired

    Internal application name, used in URLs.

    assigned_backchannel_application_name stringrequired

    Application's display Name.

    verbose_name stringrequired

    Return object's verbose_name

    verbose_name_plural stringrequired

    Return object's plural verbose_name

    meta_model_name stringrequired

    Return internal model name

    client_type ClientTypeEnum (string)

    Possible values: [confidential, public]

    client_id string

    Possible values: <= 255 characters

    client_secret string

    Possible values: <= 255 characters

    access_code_validity string

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

    access_token_validity string

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

    refresh_token_validity string

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

    include_claims_in_id_token boolean

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

    signing_key uuidnullable

    Key used to sign the tokens. Only required when JWT Algorithm is set to RS256.

    redirect_uris

    object[]

    required

  • Array [

    • matching_mode MatchingModeEnum (string)required

    Possible values: [strict, regex]

    url stringrequired

  • ]

    • sub_mode SubModeEnum (string)

    Possible values: [hashed_user_id, user_id, user_uuid, user_username, user_email, user_upn]

    issuer_mode IssuerModeEnum (string)

    Possible values: [global, per_provider]

    jwks_sources uuid[]

  • ]

Loading...