Skip to main content

providers_ssf_retrieve

GET 
/api/v3//providers/ssf/:id/

SSFProvider Viewset

Request​

Path Parameters

    id integerrequired

    A unique integer value identifying this Shared Signals Framework Provider.

Responses​

Schema
    pkID (integer)required
    namestringrequired
    componentstringrequired

    Get object component so that we know how to edit the object

    verbose_namestringrequired

    Return object's verbose_name

    verbose_name_pluralstringrequired

    Return object's plural verbose_name

    meta_model_namestringrequired

    Return internal model name

    signing_keyuuidrequired

    Key used to sign the SSF Events.

    token_obj object

    Token Serializer

    pkuuidrequired
    managedManaged by authentik (string)nullable

    Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.

    identifierstringrequired

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

    intentIntentEnum (string)

    Possible values: [verification, api, recovery, app_password]

    userinteger
    user_obj 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
    descriptionstring
    expiresdate-timenullable
    expiringboolean
    oidc_auth_providersinteger[]
    ssf_urlstringnullablerequired
    event_retentionstring

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/providers/ssf/: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