Update connection profile

PATCH

/connection-profiles/{connectionProfileId}

• app.advalidation.com
• app2.advalidation.com
• staging.advalidation.com

Update connection profile by ID

Authorizations

• HeaderBased

Parameters

Path Parameters

connectionProfileId

required

integer

ID of the connection profile to be updated

Request Body

Connection profile updates

PatchConnectionProfile

Input required to change a connection profile

object

name

Connection profile name

string

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

Responses

200

Successfully updated connection profile, returning new representation

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

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

403

403 Forbidden

403 Forbidden response

Currently authenticated user does not have permission to access or update requested object

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

404

404 Not found

404 Not found response

Requested resource or underlying resource was not found

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

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