providers_oauth2_list

GET 
/api/v3//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

200

application/json

Schema

Schema

pagination objectrequired
nextnumberrequired
previousnumberrequired
countnumberrequired
currentnumberrequired
total_pagesnumberrequired
start_indexnumberrequired
end_indexnumberrequired
results object[]required
Array [
pkID (integer)required
namestringrequired
authentication_flowuuidnullable
Flow used for authentication when the associated application is accessed by an un-authenticated user.
authorization_flowuuidrequired
Flow used when authorizing this provider.
invalidation_flowuuidrequired
Flow used ending the session from a provider.
property_mappingsuuid[]
componentstringrequired
Get object component so that we know how to edit the object
assigned_application_slugstringrequired
Internal application name, used in URLs.
assigned_application_namestringrequired
Application's display Name.
assigned_backchannel_application_slugstringrequired
Internal application name, used in URLs.
assigned_backchannel_application_namestringrequired
Application's display Name.
verbose_namestringrequired
Return object's verbose_name
verbose_name_pluralstringrequired
Return object's plural verbose_name
meta_model_namestringrequired
Return internal model name
client_typeClientTypeEnum (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Possible values: [confidential, public]
client_idstring
Possible values: <= 255 characters
client_secretstring
Possible values: <= 255 characters
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).
include_claims_in_id_tokenboolean
Include User claims from scopes in the id_token, for applications that don't access the userinfo endpoint.
signing_keyuuidnullable
Key used to sign the tokens.
encryption_keyuuidnullable
Key used to encrypt the tokens. When set, tokens will be encrypted and returned as JWEs.
redirect_uris object[]required
Array [
matching_modeMatchingModeEnum (string)required
Possible values: [strict, regex]
urlstringrequired
]
sub_modeSubModeEnum (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Possible values: [hashed_user_id, user_id, user_uuid, user_username, user_email, user_upn]
issuer_modeIssuerModeEnum (string)
Configure how the issuer field of the ID Token should be filled.
Possible values: [global, per_provider]
jwt_federation_sourcesuuid[]
jwt_federation_providersinteger[]
]

Example (auto)

{
  "pagination": {
    "next": 0,
    "previous": 0,
    "count": 0,
    "current": 0,
    "total_pages": 0,
    "start_index": 0,
    "end_index": 0
  },
  "results": [
    {
      "pk": 0,
      "name": "string",
      "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "authorization_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "invalidation_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "property_mappings": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "component": "string",
      "assigned_application_slug": "string",
      "assigned_application_name": "string",
      "assigned_backchannel_application_slug": "string",
      "assigned_backchannel_application_name": "string",
      "verbose_name": "string",
      "verbose_name_plural": "string",
      "meta_model_name": "string",
      "client_type": "confidential",
      "client_id": "string",
      "client_secret": "string",
      "access_code_validity": "string",
      "access_token_validity": "string",
      "refresh_token_validity": "string",
      "include_claims_in_id_token": true,
      "signing_key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "encryption_key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "redirect_uris": [
        {
          "matching_mode": "strict",
          "url": "string"
        }
      ],
      "sub_mode": "hashed_user_id",
      "issuer_mode": "global",
      "jwt_federation_sources": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "jwt_federation_providers": [
        0
      ]
    }
  ]
}

400

application/json

Schema

Schema

non_field_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

{
  "detail": "string",
  "code": "string"
}

Authorization: http

name: authentiktype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/providers/oauth2/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

access_code_validity — query

access_token_validity — query

application — query

authorization_flow — query

client_id — query

client_type — query

---confidentialpublic

include_claims_in_id_token — query

---truefalse

issuer_mode — query

---globalper_provider

name — query

ordering — query

page — query

page_size — query

property_mappings — query

refresh_token_validity — query

search — query

signing_key — query

sub_mode — query

---hashed_user_iduser_emailuser_iduser_upnuser_usernameuser_uuid