/auth-method-update-oauth2

post

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

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

audience

string

The audience in the JWT

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-client-ids

array of strings

The clients ids that the access is restricted to

bound-client-ids

bound-ips

array of strings

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

bound-ips

cert

string

CertificateFile Path to a file that contain the certificate in a PEM format.

cert-file-data

string

CertificateFileData PEM Certificate in a Base64 format.

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

gateway-url

string

Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.

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

jwks-json-data

string

The JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server. base64 encoded string

jwks-uri

string

The URL to the JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server.

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

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 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

201authMethodUpdateOauth2Response wraps response body.

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