Partial Update Postman Authentication Settings

PATCH 
/targets/:id/postman-authentication/

Manage Postman Authentication settings for a target.

Request

Path Parameters

id stringrequired

application/json

Body

postman_auth_folder string

Possible values: <= 255 characters

Postman folder to use for the authentication request.
The maximum length is 255 characters.

postman_auth_var_mapping nullable

Mapping of Postman variables found in the postman folders, which would be used for the authentication request.

postman_authentication_enabled boolean
fail_fast boolean

application/x-www-form-urlencoded

Body

postman_auth_folder string

Possible values: <= 255 characters

Postman folder to use for the authentication request.
The maximum length is 255 characters.

postman_auth_var_mapping nullable

Mapping of Postman variables found in the postman folders, which would be used for the authentication request.

postman_authentication_enabled boolean
fail_fast boolean

multipart/form-data

Body

postman_auth_folder string

Possible values: <= 255 characters

Postman folder to use for the authentication request.
The maximum length is 255 characters.

postman_auth_var_mapping nullable

Mapping of Postman variables found in the postman folders, which would be used for the authentication request.

postman_authentication_enabled boolean
fail_fast boolean

Responses

200

application/json

Schema

Schema

postman_auth_folder string

Possible values: <= 255 characters

Postman folder to use for the authentication request.
The maximum length is 255 characters.

postman_auth_var_mapping nullable

Mapping of Postman variables found in the postman folders, which would be used for the authentication request.

postman_authentication_enabled boolean
postman_authentication_configured stringrequired

Indicates if Postman authentication is configured for the target.

fail_fast boolean

Example (from schema)

{
  "postman_auth_folder": "string",
  "postman_authentication_enabled": true,
  "postman_authentication_configured": "string",
  "fail_fast": false
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...