---
title: "POST /configure"
method: POST
path: "/configure"
tags: ["v2"]
---

# POST /configure

`POST /configure`

## Request body

- Configure
  - `access-id` string — Access ID
  - `access-key` string — Access Key
  - `access-type` string — Access Type (access_key/password/azure_ad/saml/oidc/aws_iam/gcp/k8s/cert)
  - `account-id` string — Account id (relevant only for access-type=password where the email address is associated with more than one account)
  - `admin-email` string — Email (relevant only for access-type=password)
  - `admin-password` string — Password (relevant only for access-type=password)
  - `azure-ad-object-id` string — Azure Active Directory ObjectId (relevant only for access-type=azure_ad)
  - `azure-cloud` string — Azure cloud environment to use. Values: AzureCloud (default), AzureUSGovernment, AzureChinaCloud.
  - `cert-data` string — Certificate data encoded in base64. Used if file was not provided. (relevant only for access-type=cert in Curl Context)
  - `cert-issuer-name` string — Certificate Issuer Name
  - `cert-username` string — The username to sign in the SSH certificate (use a comma-separated list for more than one username)
  - `default-location-prefix` string — Default path prefix for name of items, targets and auth methods
  - `disable-pafxfast` string — Disable the FAST negotiation in the Kerberos authentication method
  - `gateway-spn` string — The service principal name of the gateway as registered in LDAP (i.e., HTTP/gateway)
  - `gcp-audience` string — GCP JWT audience
  - `json` boolean — Set output format to JSON
  - `k8s-auth-config-name` string — The K8S Auth config name (relevant only for access-type=k8s)
  - `kerberos-token` string — KerberosToken represents a Kerberos token generated for the gateway SPN (Service Principal Name).
  - `kerberos-username` string — TThe username for the entry within the keytab to authenticate via Kerberos
  - `key-data` string — Private key data encoded in base64. Used if file was not provided.(relevant only for access-type=cert in Curl Context)
  - `keytab-data` string — Base64-encoded content of a valid keytab file, containing the service account's entry.
  - `krb5-conf-data` string — Base64-encoded content of a valid krb5.conf file, specifying the settings and parameters required for Kerberos authentication.
  - `legacy-signing-alg-name` boolean — Set this option to output legacy ('ssh-rsa-cert-v01@openssh.com') signing algorithm name in the certificate.
  - `oci-auth-type` string — The type of the OCI configuration to use [instance/apikey/resource] (relevant only for access-type=oci)
  - `oci-group-ocid` string[] — A list of Oracle Cloud IDs groups (relevant only for access-type=oci)

## Response `200`

configureResponse wraps response body.

- ConfigureOutput
  - `profile` string
  - `token` string

## Other responses

- `default` — errorResponse wraps any error to return it as a JSON object with one "error" field.

---

[API](https://skmtc.net/akeyless/apis/akeyless-api.md) · [All operations](https://skmtc.net/akeyless/apis/akeyless-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/akeyless/akeyless-api/versions/0ceb25634501/schema)