Create auth config

post

{protocol}://{base-url}/ai/api/v1/auth_configs

Create a new authentication configuration.

Body Params

Schema for creating an auth config.

Required fields vary by auth_type:

NONE: No additional fields required. Use custom_headers for API key auth.
BASIC: Requires username and password.
CLIENT_CREDENTIALS: Requires token_url, client_id, and client_secret.
AUTHORIZATION_CODE: Requires authorization_url, token_url, and client_id.

name

string

required

length ≥ 1

Display name for this auth config.

auth_type

string

enum

required

Authentication type. Determines which other fields are required.

Allowed:

custom_headers

object | null

Custom HTTP headers to include with requests. Can be used with any auth type.

username

Username for BASIC authentication.

password

Password for BASIC authentication.

token_url

OAuth token endpoint URL. Required for CLIENT_CREDENTIALS and AUTHORIZATION_CODE.

client_id

OAuth client ID. Required for CLIENT_CREDENTIALS and AUTHORIZATION_CODE.

client_secret

OAuth client secret. Required for CLIENT_CREDENTIALS.

scopes

Space-separated OAuth scopes to request.

authorization_url

OAuth authorization endpoint URL. Required for AUTHORIZATION_CODE.

allowed_redirect_uris

array | null

Allowed redirect URIs for OAuth authorization code flow.

use_pkce

boolean

Defaults to true

Whether to use PKCE for AUTHORIZATION_CODE flow. Defaults to true.

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

201Successful Response

401Authentication required. No valid session cookie or bearer token provided, or authentication failed.

422Validation Error

500Internal server error during request processing.