providers_saml_partial_update

PATCH 
/api/v3//providers/saml/:id/

SAMLProvider Viewset

Request

Path Parameters

id integerrequired

A unique integer value identifying this SAML Provider.

application/json

Body

name string

Possible values: non-empty

authentication_flow uuidnullable

Flow used for authentication when the associated application is accessed by an un-authenticated user.

authorization_flow uuid

Flow used when authorizing this provider.

property_mappings uuid[]
acs_url uri

Possible values: non-empty and <= 200 characters

audience string

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

issuer string

Possible values: non-empty

Also known as EntityID

assertion_valid_not_before string

Possible values: non-empty

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

assertion_valid_not_on_or_after string

Possible values: non-empty

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

session_valid_not_on_or_after string

Possible values: non-empty

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

name_id_mapping uuidnullable

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

digest_algorithm DigestAlgorithmEnum (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_algorithm SignatureAlgorithmEnum (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_kp uuidnullable

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

verification_kp uuidnullable

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

sp_binding SpBindingEnum (string)

Possible values: [redirect, post]

default_relay_state string

Default relay_state value for IDP-initiated logins

Responses

200

application/json

Schema

Schema

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

acs_url urirequired

Possible values: <= 200 characters

audience string

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

issuer string

Also known as EntityID

assertion_valid_not_before string

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

assertion_valid_not_on_or_after string

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

session_valid_not_on_or_after string

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

name_id_mapping uuidnullable

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

digest_algorithm DigestAlgorithmEnum (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_algorithm SignatureAlgorithmEnum (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_kp uuidnullable

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

verification_kp uuidnullable

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

sp_binding SpBindingEnum (string)

Possible values: [redirect, post]

default_relay_state string

Default relay_state value for IDP-initiated logins

url_download_metadata stringrequired

Get metadata download URL

url_sso_post stringrequired

Get SSO Post URL

url_sso_redirect stringrequired

Get SSO Redirect URL

url_sso_init stringrequired

Get SSO IDP-Initiated URL

url_slo_post stringrequired

Get SLO POST URL

url_slo_redirect stringrequired

Get SLO redirect URL

Example (from schema)

{
  "pk": 0,
  "name": "string",
  "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "authorization_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "component": "string",
  "assigned_application_slug": "string",
  "assigned_application_name": "string",
  "assigned_backchannel_application_slug": "string",
  "assigned_backchannel_application_name": "string",
  "verbose_name": "string",
  "verbose_name_plural": "string",
  "meta_model_name": "string",
  "acs_url": "string",
  "audience": "string",
  "issuer": "string",
  "assertion_valid_not_before": "string",
  "assertion_valid_not_on_or_after": "string",
  "session_valid_not_on_or_after": "string",
  "name_id_mapping": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "digest_algorithm": "http://www.w3.org/2000/09/xmldsig#sha1",
  "signature_algorithm": "http://www.w3.org/2000/09/xmldsig#rsa-sha1",
  "signing_kp": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "verification_kp": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sp_binding": "redirect",
  "default_relay_state": "string",
  "url_download_metadata": "string",
  "url_sso_post": "string",
  "url_sso_redirect": "string",
  "url_sso_init": "string",
  "url_slo_post": "string",
  "url_slo_redirect": "string"
}

400

application/json

Schema

Schema

non_field_errors string[]
code string

Example (from schema)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

{
  "detail": "string",
  "code": "string"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PATCH '/api/v3/providers/saml/:id/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "authorization_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "acs_url": "string",
  "audience": "string",
  "issuer": "string",
  "assertion_valid_not_before": "string",
  "assertion_valid_not_on_or_after": "string",
  "session_valid_not_on_or_after": "string",
  "name_id_mapping": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "digest_algorithm": "http://www.w3.org/2000/09/xmldsig#sha1",
  "signature_algorithm": "http://www.w3.org/2000/09/xmldsig#rsa-sha1",
  "signing_kp": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "verification_kp": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sp_binding": "redirect",
  "default_relay_state": "string"
}'

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

id — pathrequired

Body

{
  "name": "string",
  "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "authorization_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "acs_url": "string",
  "audience": "string",
  "issuer": "string",
  "assertion_valid_not_before": "string",
  "assertion_valid_not_on_or_after": "string",
  "session_valid_not_on_or_after": "string",
  "name_id_mapping": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "digest_algorithm": "http://www.w3.org/2000/09/xmldsig#sha1",
  "signature_algorithm": "http://www.w3.org/2000/09/xmldsig#rsa-sha1",
  "signing_kp": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "verification_kp": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sp_binding": "redirect",
  "default_relay_state": "string"
}