providers_oauth2_partial_update

PATCH 
/api/v3//providers/oauth2/:id/

OAuth2Provider Viewset

Request

Path Parameters

id integerrequired

A unique integer value identifying this OAuth2/OpenID Provider.

application/json

Body

namestring
Possible values: non-empty
authentication_flowuuidnullable
Flow used for authentication when the associated application is accessed by an un-authenticated user.
authorization_flowuuid
Flow used when authorizing this provider.
invalidation_flowuuid
Flow used ending the session from a provider.
property_mappingsuuid[]
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: non-empty and <= 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).
Possible values: non-empty
access_token_validitystring
Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).
Possible values: non-empty
refresh_token_validitystring
Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).
Possible values: non-empty
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[]
Array [
matching_modeMatchingModeEnum (string)required
Possible values: [strict, regex]
urlstringrequired
Possible values: non-empty
]
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[]

Responses

200

application/json

Schema

Schema

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)

{
  "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.Patch, "/api/v3/providers/oauth2/:id/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"authentication_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"authorization_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"invalidation_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"property_mappings\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"client_type\": \"confidential\",\n  \"client_id\": \"string\",\n  \"client_secret\": \"string\",\n  \"access_code_validity\": \"string\",\n  \"access_token_validity\": \"string\",\n  \"refresh_token_validity\": \"string\",\n  \"include_claims_in_id_token\": true,\n  \"signing_key\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"encryption_key\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"redirect_uris\": [\n    {\n      \"matching_mode\": \"strict\",\n      \"url\": \"string\"\n    }\n  ],\n  \"sub_mode\": \"hashed_user_id\",\n  \"issuer_mode\": \"global\",\n  \"jwt_federation_sources\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"jwt_federation_providers\": [\n    0\n  ]\n}", null, "application/json");
request.Content = content;
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

id — pathrequired

Body

{
  "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"
  ],
  "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
  ]
}