Skip to main content

providers_saml_list

GET 
/api/v3//providers/saml/

SAMLProvider Viewset

Request​

Query Parameters

    acs_url string
    assertion_valid_not_before string
    assertion_valid_not_on_or_after string
    audience string
    authentication_flow uuid
    authn_context_class_ref_mapping uuid
    authorization_flow uuid
    backchannel_application uuid
    default_relay_state string
    digest_algorithm string

    Possible values: [http://www.w3.org/2000/09/xmldsig#sha1, http://www.w3.org/2001/04/xmldsig-more#sha384, http://www.w3.org/2001/04/xmlenc#sha256, http://www.w3.org/2001/04/xmlenc#sha512]

    encryption_kp uuid
    invalidation_flow uuid
    is_backchannel boolean
    issuer string
    name string
    name_id_mapping uuid
    ordering string

    Which field to use when ordering the results.

    page integer

    A page number within the paginated result set.

    page_size integer

    Number of results to return per page.

    property_mappings uuid[]
    search string

    A search term.

    session_valid_not_on_or_after string
    sign_assertion boolean
    sign_response boolean
    signature_algorithm string

    Possible values: [http://www.w3.org/2000/09/xmldsig#dsa-sha1, http://www.w3.org/2000/09/xmldsig#rsa-sha1, http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha1, http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256, http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha384, http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha512, http://www.w3.org/2001/04/xmldsig-more#rsa-sha256, http://www.w3.org/2001/04/xmldsig-more#rsa-sha384, http://www.w3.org/2001/04/xmldsig-more#rsa-sha512]

    signing_kp uuid
    sp_binding Service Provider Binding

    Possible values: [post, redirect]

    This determines how authentik sends the response back to the Service Provider.

    verification_kp uuid

Responses​

Schema
    pagination objectrequired
    nextnumberrequired
    previousnumberrequired
    countnumberrequired
    currentnumberrequired
    total_pagesnumberrequired
    start_indexnumberrequired
    end_indexnumberrequired
    results object[]required
  • Array [
    • 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

    acs_urlurirequired
    audiencestring

    Value of the audience restriction field of the assertion. When left empty, no audience restriction will be added.

    issuerstring

    Also known as EntityID

    assertion_valid_not_beforestring

    Assertion valid not before current time + this value (Format: hours=-1;minutes=-2;seconds=-3).

    assertion_valid_not_on_or_afterstring

    Assertion not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).

    session_valid_not_on_or_afterstring

    Session not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).

    name_id_mappinguuidnullable

    Configure how the NameID value will be created. When left empty, the NameIDPolicy of the incoming request will be considered

    authn_context_class_ref_mappinguuidnullable

    Configure how the AuthnContextClassRef value will be created. When left empty, the AuthnContextClassRef will be set based on which authentication methods the user used to authenticate.

    digest_algorithmDigestAlgorithmEnum (string)

    Possible values: [http://www.w3.org/2000/09/xmldsig#sha1, http://www.w3.org/2001/04/xmlenc#sha256, http://www.w3.org/2001/04/xmldsig-more#sha384, http://www.w3.org/2001/04/xmlenc#sha512]

    signature_algorithmSignatureAlgorithmEnum (string)

    Possible values: [http://www.w3.org/2000/09/xmldsig#rsa-sha1, http://www.w3.org/2001/04/xmldsig-more#rsa-sha256, http://www.w3.org/2001/04/xmldsig-more#rsa-sha384, http://www.w3.org/2001/04/xmldsig-more#rsa-sha512, http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha1, http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256, http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha384, http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha512, http://www.w3.org/2000/09/xmldsig#dsa-sha1]

    signing_kpuuidnullable

    Keypair used to sign outgoing Responses going to the Service Provider.

    verification_kpuuidnullable

    When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default.

    encryption_kpuuidnullable

    When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the the private key.

    sign_assertionboolean
    sign_responseboolean
    sp_bindingService Provider Binding (string)

    This determines how authentik sends the response back to the Service Provider.

    Possible values: [redirect, post]

    default_relay_statestring

    Default relay_state value for IDP-initiated logins

    url_download_metadatastringrequired

    Get metadata download URL

    url_sso_poststringrequired

    Get SSO Post URL

    url_sso_redirectstringrequired

    Get SSO Redirect URL

    url_sso_initstringrequired

    Get SSO IDP-Initiated URL

    url_slo_poststringrequired

    Get SLO POST URL

    url_slo_redirectstringrequired

    Get SLO redirect URL

  • ]

Authorization: http

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