/auth-method-update-oidc

post

https://api.akeyless.io/auth-method-update-oidc

Body Params

access-expires

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

audience

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

client-id

string

Client ID

client-secret

string

Client Secret

delete_protection

string

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

description

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

force-sub-claims

boolean

if true: enforce role-association must include sub claims

gw-bound-ips

array of strings

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

gw-bound-ips

issuer

string

Issuer URL

json

boolean

Defaults to false

Set output format to JSON

jwt-ttl

int64

Defaults to 0

Jwt TTL

name

string

required

Auth Method name

new-name

string

Auth Method new name

product-type

array of strings

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

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

required-scopes-prefix

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)

subclaims-delimiters

array of strings

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

subclaims-delimiters

token

string

Authentication token (see /auth and /configure)

uid-token

string

The universal identity token, Required only for universal_identity authentication

unique-identifier

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

201authMethodUpdateOIDCResponse wraps response body.

defaulterrorResponse wraps any error to return it as a JSON object with one "error" field.