---
id: providers-oauth-2-retrieve
title: "providers_oauth2_retrieve"
description: "OAuth2Provider Viewset"
sidebar_label: "providers_oauth2_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJzNWNtu2zgQ/RVCL9tivVHXbReLFAU2aNPCvSVI0vahKARaom3WFKmSVFLX8L/vGVKy5fiSBG2x+xBElmaGZy6cOeQ8MZWw3EujB0VymFTWXMpCWJcZXvtJP7PCWykuRdJLCuFyKyuSheTJEX0/beTZBymunPAQq7jlpfCwkRx+mieShCvuJ/ik8QG/ZIFnl09EyZPDeeJnVXirvRgLmyyur3TEai2/1oI1EuySK/pVCO3laCb1mPmJdCwiSk8qoQfPWYvsAGtZ8bWWVsBBb2ux+NxLPB8TvJW/CV46kddW+lnATe7TAlP8+kwqVrjKaCccYe4/eED/cgNI2tMjryol8xDJ9Isj4PNNH83wi8j9TbE8F1ZyJb8jGD1CiAx5GdetplsiRth4caLVLDoI96RXJDF4TuGMYV+qOWRUj+lD62OEnY2UudqU6yUjY0sOJ5O6DqnTtVJ8SAvE1dadeQErrHaiYNBj60uwK/xAtgTjzplccg+xTuQY0sjzXDhSH84Y18j9Hx0beA3TSGqD3lj5/W7gd4ENyFqTy5qqllW0WKZilpWADBHXWY9by2cwL70o3c04FjCXmxIF1ZTPdfF1mC+FZ7F22FKLOQOM3LMrwaYabkzw5w0ThfQhxMtiW68OipxzcqxFkXVCnzlVj29GMkDNWc3VWtaowHoxjFKz92dv3MGtl91enBs9YKXxm2OFdJXiM/YOuvtXGvJ8mk+41kL9V87ugvBLHL8UdmicuKXxM+Frq5tCgfk17RusZ5WqLVd3XyTq3bgWRgjPSlMgandyRrY5C7psl/lcSeyhLJpE91bqZBT6vtB1SZMBrX0URwycxN6vh8gDTYnrKNpe+yxYvMDXYzJBI2Md4LOORRbXR7ezguW8onbKzIiVHPjxFxsQPnV0MJlIBK+lZTnGWXztDthpALdmU+rGarJyFn1nSxRL/u2N0GMM6MP+48craUxDDP9bacSWneWIeIbhLIswRG8s7aDFSMsxbTwLqgxbjObGCGlkmMeWWp2XpWC/x5Ycp/+9F6GfHqLr1dY9/fNJKXXthXvafwLgRhfu6cP7cUxEcN5Mhb4DuguS/5W4rBiBUkz+f8BQOqpGJnPFZekyqVE4EWUH3NAYJbje0jKDMnvvCE2wwEbWlMzlGJ6OWibVdWuxF0nCqsm5ONMKtDvfUIGgQFNf6hHGmy4qg00SoFKLRYyyqdgauLsRl9diFts6higZDusGlNhi1DxYyyMjWXj18YIdqTH4gp+UxFzAf0n37Lz/+K8mxQXEc5+BVm4lBesAjql1McHzCcbKgPLKmRZXTEktorv1MLTE7R1rwt0E84YilQV3rz01QYjPjppkaI3hN2iqVMuPld7X6M7r4VuA2NflxjVa0FVIJPecOdScAqETMb7ctYw+VMkgEnkJlsVQpGjcDjSHg2n3QgoKMeK18h0rozYg0rkagHfHZKzMMPZviLVkbp9zg2DxVv4FvkW1HFQASgBdbNAMB5CwT9dAKyWKAPvL1dRlDvswFz/AIVegj/QsVGNkHEScCcOrj69bOE4olCE+xUURXb3MBiq2S7ADwF9keNE9in3awwf3UdTbUqvbssCtB4kuO9/kIs2RqkfHsWucaztJ+rwK6fpZDzHZOO9SAh791PPlB5oTkb0eW2s2j5Wa/Kb6zQR9v0NRxoNMse18SbO3wEzDslyddtfrVNgKWkS2Mx4Pf2I8XgqNaZKzo9PBjoAUyLjcQm73etut7cZAJ/HNonvcjKx3YugiZtzcpRDJStLlNUUar2XSuSwWKd2iCHvZ3rTUVpEsr2R6+TANrau90TinwETPOvcaSx8m3lftlUwY7gIU0gZANHODZOPFSj1UuovY+w/6jw7+PuhvRPotnxKVvXYL4GRZqXCAoYTyPCQ0jiCAEUqZf8ZmudKBNBR3ZBuTOIS+uUd6O7igkRXcJhfcYZqOMYzr4QF2b9oxka6ehpgIKdHs9M3g2fG78+PgZoWZU3LdMb4MOYshZ7tuwjpVuftSrAm0F998ihOc1ORRQD5vkty9i+olcU08HIZGT3U0AUQSm8+HmI3vrVos6DXGqKUbKzxecisjvUE14KhIz6ilEc4I18lOF/S9s6Zu77Mfv2rb6mjbSjQ1kmCS6r2XBNpG14GLz5Ca4IyGqiPw8QMdECrfUdnY81Tjyy3z8viiaeZdnhpLudc+kPWtcBDWIBHGNkLboovEFwAXi38BVUl0NQ==
sidebar_class_name: "get api-method"
info_path: docs/developer-docs/api/reference/authentik
custom_edit_url: null
hide_send_button: true
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"providers_oauth2_retrieve"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/providers/oauth2/{id}/"}
>
  
</MethodEndpoint>



OAuth2Provider Viewset

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<details
  style={{"marginBottom":"1rem"}}
  className={"openapi-markdown__details"}
  data-collapsed={false}
  open={true}
>
  <summary
    style={{}}
  >
    <h3
      className={"openapi-markdown__details-summary-header-params"}
    >
      Path Parameters
    </h3>
  </summary><div>
    <ul>
      <ParamsItem
        className={"paramsItem"}
        param={{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this OAuth2/OpenID Provider.","required":true}}
      >
        
      </ParamsItem>
    </ul>
  </div>
</details><div>
  <div>
    <ApiTabs
      label={undefined}
      id={undefined}
    >
      <TabItem
        label={"200"}
        value={"200"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"pk"}
                        required={true}
                        schemaName={"ID (integer)"}
                        qualifierMessage={undefined}
                        schema={{"type":"integer","readOnly":true,"title":"ID"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"authentication_flow"}
                        required={false}
                        schemaName={"uuid"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","format":"uuid","nullable":true,"description":"Flow used for authentication when the associated application is accessed by an un-authenticated user."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"authorization_flow"}
                        required={true}
                        schemaName={"uuid"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","format":"uuid","description":"Flow used when authorizing this provider."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"property_mappings"}
                        required={false}
                        schemaName={"uuid[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"component"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Get object component so that we know how to edit the object","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"assigned_application_slug"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Internal application name, used in URLs.","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"assigned_application_name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Application's display Name.","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"assigned_backchannel_application_slug"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Internal application name, used in URLs.","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"assigned_backchannel_application_name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Application's display Name.","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"verbose_name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Return object's verbose_name","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"verbose_name_plural"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Return object's plural verbose_name","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"meta_model_name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Return internal model name","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"client_type"}
                        required={false}
                        schemaName={"ClientTypeEnum (string)"}
                        qualifierMessage={"**Possible values:** [`confidential`, `public`]"}
                        schema={{"enum":["confidential","public"],"type":"string","title":"ClientTypeEnum"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"client_id"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={"**Possible values:** `<= 255 characters`"}
                        schema={{"type":"string","maxLength":255}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"client_secret"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={"**Possible values:** `<= 255 characters`"}
                        schema={{"type":"string","maxLength":255}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"access_code_validity"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Access codes not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3)."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"access_token_validity"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3)."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"refresh_token_validity"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3)."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"include_claims_in_id_token"}
                        required={false}
                        schemaName={"boolean"}
                        qualifierMessage={undefined}
                        schema={{"type":"boolean","description":"Include User claims from scopes in the id_token, for applications that don't access the userinfo endpoint."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"signing_key"}
                        required={false}
                        schemaName={"uuid"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","format":"uuid","nullable":true,"description":"Key used to sign the tokens. Only required when JWT Algorithm is set to RS256."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"redirect_uris"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Enter each URI on a new line."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"sub_mode"}
                        required={false}
                        schemaName={"SubModeEnum (string)"}
                        qualifierMessage={"**Possible values:** [`hashed_user_id`, `user_id`, `user_uuid`, `user_username`, `user_email`, `user_upn`]"}
                        schema={{"enum":["hashed_user_id","user_id","user_uuid","user_username","user_email","user_upn"],"type":"string","title":"SubModeEnum"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"issuer_mode"}
                        required={false}
                        schemaName={"IssuerModeEnum (string)"}
                        qualifierMessage={"**Possible values:** [`global`, `per_provider`]"}
                        schema={{"enum":["global","per_provider"],"type":"string","title":"IssuerModeEnum"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"jwks_sources"}
                        required={false}
                        schemaName={"uuid[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string","format":"uuid","title":"Any JWT signed by the JWK of the selected source can be used to authenticate."},"title":"Any JWT signed by the JWK of the selected source can be used to authenticate."}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"pk\": 0,\n  \"name\": \"string\",\n  \"authentication_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"authorization_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"property_mappings\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"component\": \"string\",\n  \"assigned_application_slug\": \"string\",\n  \"assigned_application_name\": \"string\",\n  \"assigned_backchannel_application_slug\": \"string\",\n  \"assigned_backchannel_application_name\": \"string\",\n  \"verbose_name\": \"string\",\n  \"verbose_name_plural\": \"string\",\n  \"meta_model_name\": \"string\",\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  \"redirect_uris\": \"string\",\n  \"sub_mode\": \"hashed_user_id\",\n  \"issuer_mode\": \"global\",\n  \"jwks_sources\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ]\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"400"}
        value={"400"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"non_field_errors"}
                        required={false}
                        schemaName={"string[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string"}}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        name={"property name*"}
                        required={false}
                        schemaName={"any"}
                        qualifierMessage={undefined}
                        schema={{"type":"object","description":"Validation Error","properties":{"non_field_errors":{"type":"array","items":{"type":"string"}},"code":{"type":"string"}},"additionalProperties":{},"title":"ValidationError"}}
                        collapsible={false}
                        discriminator={false}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"non_field_errors\": [\n    \"string\"\n  ],\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"403"}
        value={"403"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"detail"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"detail\": \"string\",\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>
      