Create Credential

POST 
/credentials/

Call auditlog tasks if applicable to query.

Request

application/json

Body

required

name stringrequired

Possible values: <= 255 characters

team stringnullable

A unique Base58 value identifying this object.

description string

Possible values: <= 1024 characters

is_sensitive boolean
value nullablerequired

Value of credential. Returns null if sensitive.

application/x-www-form-urlencoded

Body

required

name stringrequired

Possible values: <= 255 characters

team stringnullable

A unique Base58 value identifying this object.

description string

Possible values: <= 1024 characters

is_sensitive boolean
value nullablerequired

Value of credential. Returns null if sensitive.

multipart/form-data

Body

required

name stringrequired

Possible values: <= 255 characters

team stringnullable

A unique Base58 value identifying this object.

description string

Possible values: <= 1024 characters

is_sensitive boolean
value nullablerequired

Value of credential. Returns null if sensitive.

Responses

201

application/json

Schema

Schema

id stringrequired

A unique Base58 value identifying this object.

uri stringrequired
name stringrequired

Possible values: <= 255 characters

team stringnullable

A unique Base58 value identifying this object.

description string

Possible values: <= 1024 characters

is_sensitive boolean
value nullablerequired

Value of credential. Returns null if sensitive.

created_at date-timerequired
updated_at date-timerequired

creator

object

required

id stringrequired

A unique Base58 value identifying this object.

email email

Possible values: <= 254 characters

Email of the user.

name stringrequired

Possible values: <= 60 characters

Name of the user.

usage_count integerrequired

references

object[]

required

Array [

root_object_id stringrequired

ID of the object where the Credential is used.

root_object_type stringrequired

Type of the object where the Credential is used (e.g. Target, Domain).

root_object_display_name stringrequired

Display name of the object where the Credential is used.

ui_reference_key stringrequired

The key to identify the field where the Credential is used.

]

Example (from schema)

{
  "id": "string",
  "uri": "string",
  "name": "string",
  "team": "string",
  "description": "string",
  "is_sensitive": true,
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "creator": {
    "id": "string",
    "email": "[email protected]",
    "name": "string"
  },
  "usage_count": 0,
  "references": [
    {
      "root_object_id": "string",
      "root_object_type": "string",
      "root_object_display_name": "string",
      "ui_reference_key": "string"
    }
  ]
}

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."
}

404

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

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

Loading...