Skip to main content

oauth2_authorization_codes_retrieve

GET 
/api/v3//oauth2/authorization_codes/:id/

AuthorizationCode Viewset

Request​

Path Parameters

    id integerrequired

    A unique integer value identifying this Authorization Code.

Responses​

Schema
    pkID (integer)required
    provider objectrequired

    OAuth2Provider Serializer

    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[]
    user objectrequired

    User Serializer

    pkID (integer)required
    usernamestringrequired

    Possible values: <= 150 characters

    namestringrequired

    User's display name.

    is_activeActive (boolean)

    Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

    last_logindate-timenullable
    is_superuserbooleanrequired
    groupsuuid[]
    groups_obj object[]nullablerequired
  • Array [
    • pkuuidrequired
    num_pkintegerrequired

    Get a numerical, int32 ID for the group

    namestringrequired
    is_superuserboolean

    Users added to this group will be superusers.

    parentuuidnullable
    parent_namestringnullablerequired
    attributes object
    property name*any
  • ]
    • emailemail

    Possible values: <= 254 characters

    avatarstringrequired

    User's avatar, either a http/https URL or a data URI

    attributes object
    property name*any
    uidstringrequired
    pathstring
    typeUserTypeEnum (string)

    Possible values: [internal, external, service_account, internal_service_account]

    uuiduuidrequired
    password_change_datedate-timerequired
    is_expiredbooleanrequired

    Check if token is expired yet.

    expiresdate-timenullable
    scopestring[]required

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/oauth2/authorization_codes/:id/");
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
Parameters
— pathrequired