v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/configure

Request body

access-idstring

Access ID

access-keystring

Access Key

access-typestring

Access Type (access_key/password/azure_ad/saml/oidc/aws_iam/gcp/k8s/cert)

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-ad-object-idstring

Azure Active Directory ObjectId (relevant only for access-type=azure_ad)

azure-cloudstring

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

cert-datastring

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

cert-issuer-namestring

Certificate Issuer Name

cert-usernamestring

The username to sign in the SSH certificate (use a comma-separated list for more than one username)

default-location-prefixstring

Default path prefix for name of items, targets and auth methods

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)

gcp-audiencestring

GCP JWT audience

jsonboolean

Set output format to JSON

k8s-auth-config-namestring

The K8S Auth config name (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 in Curl Context)

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.

legacy-signing-alg-nameboolean

Set this option to output legacy ('ssh-rsa-cert-v01@openssh.com') signing algorithm name in the certificate.

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)

Response

configureResponse wraps response body.

profilestring
tokenstring