v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/auth

Request body

access-idstring

Access ID

access-keystring

Access key (relevant only for access-type=access_key)

access-typestring

Access Type (access_key/password/saml/ldap/k8s/azure_ad/oidc/aws_iam/universal_identity/jwt/gcp/cert/oci/kerberos)

account-idstring

Account id (relevant only for access-type=password where the email address is associated with more than one account)

admin-emailstring

Email (relevant only for access-type=password)

admin-passwordstring

Password (relevant only for access-type=password)

azure-cloudstring

Azure cloud environment to use. Values: AzureCloud (default), AzureUSGovernment, AzureChinaCloud.

cert-challengestring

Certificate challenge encoded in base64. (relevant only for access-type=cert)

cert-datastring

Certificate data encoded in base64. Used if file was not provided. (relevant only for access-type=cert)

cloud-idstring

The cloud identity (relevant only for access-type=azure_ad,aws_iam,gcp)

debugboolean
disable-pafxfaststring

Disable the FAST negotiation in the Kerberos authentication method

gateway-spnstring

The service principal name of the gateway as registered in LDAP (i.e., HTTP/gateway)

gateway-urlstring

Gateway URL relevant only for access-type=k8s/oauth2/saml/oidc

gcp-audiencestring

GCP JWT audience

jsonboolean

Set output format to JSON

jwtstring

The Json Web Token (relevant only for access-type=jwt/oidc)

k8s-auth-config-namestring

The K8S Auth config name (relevant only for access-type=k8s)

k8s-service-account-tokenstring

The K8S service account token. (relevant only for access-type=k8s)

kerberos-tokenstring

KerberosToken represents a Kerberos token generated for the gateway SPN (Service Principal Name).

kerberos-usernamestring

TThe username for the entry within the keytab to authenticate via Kerberos

key-datastring

Private key data encoded in base64. Used if file was not provided.(relevant only for access-type=cert)

keytab-datastring

Base64-encoded content of a valid keytab file, containing the service account's entry.

krb5-conf-datastring

Base64-encoded content of a valid krb5.conf file, specifying the settings and parameters required for Kerberos authentication.

ldap-passwordstring

LDAP password (relevant only for access-type=ldap)

oci-auth-typestring

The type of the OCI configuration to use [instance/apikey/resource] (relevant only for access-type=oci)

oci-group-ocidstring[]

A list of Oracle Cloud IDs groups (relevant only for access-type=oci)

otpstring
signed-cert-challengestring

Signed certificate challenge encoded in base64. (relevant only for access-type=cert)

uid-tokenstring

The universal_identity token (relevant only for access-type=universal_identity)

use-remote-browserboolean

Returns a link to complete the authentication remotely (relevant only for access-type=saml/oidc)

usernamestring

LDAP username (relevant only for access-type=ldap)

Response

authResponse wraps response body.

complete_auth_linkstring
expirationstring
tokenstring