Skip to main content

core_user_consent_retrieve

GET 
/api/v3//core/user_consent/:id/

UserConsent Viewset

Request​

Path Parameters

    id integerrequired

    A unique integer value identifying this User Consent.

Responses​

Schema

    pk ID (integer)required
    expires date-timenullable
    expiring boolean

    user

    object

    required

    User Serializer

    pk ID (integer)required
    username stringrequired

    Possible values: <= 150 characters

    name stringrequired

    User's display name.

    is_active Active (boolean)

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

    last_login date-timenullable
    is_superuser booleanrequired
    groups uuid[]

    groups_obj

    object[]

    nullable

    required

  • Array [

    • pk uuidrequired
    num_pk integerrequired

    Get a numerical, int32 ID for the group

    name stringrequired

    Possible values: <= 80 characters

    is_superuser boolean

    Users added to this group will be superusers.

    parent uuidnullable
    parent_name stringnullablerequired

    attributes

    object

  • ]

    • email email

    Possible values: <= 254 characters

    avatar stringrequired

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

    attributes

    object

    uid stringrequired
    path string
    type UserTypeEnum (string)

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

    uuid uuidrequired

    application

    object

    required

    Application Serializer

    pk uuidrequired
    name stringrequired

    Application's display Name.

    slug stringrequired

    Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    Internal application name, used in URLs.

    provider integernullable

    provider_obj

    object

    required

    Provider Serializer

    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

    backchannel_providers integer[]

    backchannel_providers_obj

    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

  • ]

    • launch_url stringnullablerequired

    Allow formatting of launch URL

    open_in_new_tab boolean

    Open launch URL in a new browser tab or window.

    meta_launch_url uri
    meta_icon stringnullablerequired

    Get the URL to the App Icon image. If the name is /static or starts with http it is returned as-is

    meta_description string
    meta_publisher string
    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    group string
    permissions string
curl -L -X GET '/api/v3/core/user_consent/:id/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Request Collapse all
Base URL
/api/v3
Auth
Parameters
— pathrequired