Create a new authentication configuration item

Create a new configuration for an API or endpoint to extract authentication or authorization items.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Specifies a custom configuration that API Security uses to extract authorization and authentication items.

uuid
required
length ≤ 50

The ID of the API that this authentication configuration applies to.

string
enum
required

An enumeration for auth type priority.

Allowed:
string
enum
required

An enumeration for auth type priority.

Allowed:
string
enum
required

An enumeration for auth type priority.

Allowed:
string
enum
required

An enumeration for auth type priority.

Allowed:
uuid
length ≤ 50

If this authentication configuration applies to a single endpoint, this parameter contains the ID of that endpoint. If this parameter is not set, the authentication configuration applies to every endpoint of the API specified in the apiId parameter.

string
length ≤ 300

The name of the endpoint that this authentication configuration applies to.

header
object

Configuration for discovering and parsing of explicit headers as part of a custom authentication extraction configuration.

jwt
object

Configuration for discovering and parsing a JWT token as part of a custom authentication extraction configuration.

tokens
array of objects
length ≤ 100

A list of token analysis configurations.

tokens
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json