API Reference

/auth-method-create-oidc

post
https://api.akeyless.io/auth-method-create-oidc
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

authMethodCreateOIDC is a command that creates a new auth method that will
be available to authenticate using OIDC.

int64
Defaults to 0

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

allowed-client-type
array of strings

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

allowed-client-type
allowed-redirect-uri
array of strings

Allowed redirect URIs after the authentication

allowed-redirect-uri
string

Audience claim to be used as part of the authentication flow. In case set, it must match the one configured on the Identity Provider's Application

audit-logs-claims
array of strings

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

audit-logs-claims
bound-ips
array of strings

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

bound-ips
string

Client ID

string

Client Secret

string

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

string

Auth Method description

expiration-event-in
array of strings

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

expiration-event-in
boolean

if true: enforce role-association must include sub claims

string

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

gw-bound-ips
array of strings

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

gw-bound-ips
string

Issuer URL

boolean
Defaults to false

Set output format to JSON

int64
Defaults to 0

Jwt TTL

string
required

Auth Method name

product-type
array of strings

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

product-type
required-scopes
array of strings

RequiredScopes is a list of required scopes that the oidc method will request from the oidc provider and the user must approve

required-scopes
string

RequiredScopesPrefix is a a prefix to add to all required-scopes when requesting them from the oidc server (for example, azures' Application ID URI)

string

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

string

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

string

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

string

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-delimiters
array of strings

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

subclaims-delimiters
string

Authentication token (see /auth and /configure)

string

The universal identity token, Required only for universal_identity authentication

string
required

A unique identifier (ID) value should be configured for OIDC, 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.

Responses

Updated 26 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 26 days ago

Did this page help you?
Footer Section