AKakeyless
Authentication

POST /auth-method-create-saml

Request

  • Base URL
    https://api.akeyless.io
  • URL
    https://api.akeyless.io/auth-method-create-saml
  • Auth
    none declared

Request body

access-expiresinteger

Access expiration date in Unix timestamp (select 0 for access without expiry date)

allowed-client-typestring[]

limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]

allowed-redirect-uristring[]

Allowed redirect URIs after the authentication

audit-logs-claimsstring[]

Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"

bound-ipsstring[]

A CIDR whitelist with the IPs that the access is restricted to

delete_protectionstring

Protection from accidental deletion of this object [true/false]

descriptionstring

Auth Method description

expiration-event-instring[]

How many days before the expiration of the auth method would you like to be notified.

force-sub-claimsboolean

if true: enforce role-association must include sub claims

gateway-urlstring

Akeyless Gateway URL (Configuration Management port). Relevant only when working with Gateway mode

gw-bound-ipsstring[]

A CIDR whitelist with the GW IPs that the access is restricted to

idp-metadata-urlstring

IDP metadata url

idp-metadata-xml-datastring

IDP metadata xml data

jsonboolean

Set output format to JSON

jwt-ttlinteger

Jwt TTL

namestring required

Auth Method name

product-typestring[]

Choose the relevant product type for the auth method [sm, sra, pm, dp, ca, ara]

scim-bearer-access-idstring

Access ID of the API Key auth method the IdP uses as the SCIM bearer

scim-enabledstring

Enable SCIM provisioning for this auth method [true/false]

scim-endpointstring

Where the IdP reaches the SCIM endpoint [public/private]. public is served by Akeyless, private by your own Akeyless Gateway

scim-gateway-urlstring

URL of the Akeyless Gateway that serves the SCIM endpoint to the IdP, for example https://gateway.example.com:8000. Required for the private endpoint

subclaims-delimitersstring[]

A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

unique-identifierstring required

A unique identifier (ID) value should be configured for OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example. Whenever a user logs in with a token, these authentication types issue a "sub claim" that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.

use-dedicated-saml-urlsboolean

Use dedicated per-access-id SP URLs for login

Response

authMethodCreateSAMLResponse wraps response body.

access_idstring
access_keystring
namestring
prv_keystring
scim_base_urlstring

SCIM Base URL the IdP calls, set when SCIM flags were given

Changes

No recorded changes to this operation across all 1 revision of this API.