Skip to content

Create connection profile

POST
/connection-profiles

Create new connection profile

New connection profile data

NewConnectionProfile

Input required to create a new connection profile

object
name
required

Connection profile name

string
withoutCookiesAction
required

Default action for connections not setting cookies

string
Allowed values: pass warn fail
withCookiesAction
required

Default action for connections setting cookies

string
Allowed values: pass warn fail

Successfully created new connection profile, returning it

object
data
ConnectionProfile

Object representing a connection profile

object
id

Internal connection profile ID

integer
name

Connection profile name

string
createdAt

Date of connection profile creation

date
updatedAt

Date of connection profile update (can be null)

date
withoutCookiesAction

Default action for connections not setting cookies

string
Allowed values: pass warn fail
withCookiesAction

Default action for connections setting cookies

string
Allowed values: pass warn fail

401 Authentication failed

401 Authentication failed response

Unable to authenticate user

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string

422 Unprocessable entity

422 Unprocessable entity

There is something wrong with the content of the request, typically missing or improperly formatted fields

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string