Jump to

• Request
• Response

Create a Credential for an Organization

post

/api/v2/organizations/{id}/credentials/

Make a POST request to this resource with the following credential fields to create a new credential associated with this organization.

• name: Name of this credential. (string, required)

• description: Optional description of this credential. (string, default="")

• credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)

• inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Body ()

Root Schema : schema

Type: object

Show Source

• credential_type(required): integer
  Specify the type of credential you want to create. Refer to the documentation for details on each type.
• description: string
• inputs: object inputs
  Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
• name(required): string
• organization: integer
  Inherit permissions from organization roles. If provided on creation, do not give either user or team.

{
    "properties":{
        "credential_type":{
            "description":"Specify the type of credential you want to create. Refer to the documentation for details on each type.",
            "type":"integer"
        },
        "description":{
            "description":"",
            "type":"string"
        },
        "inputs":{
            "description":"Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.",
            "type":"object"
        },
        "name":{
            "description":"",
            "type":"string"
        },
        "organization":{
            "description":"Inherit permissions from organization roles. If provided on creation, do not give either user or team.",
            "type":"integer"
        }
    },
    "required":[
        "name",
        "credential_type"
    ],
    "type":"object"
}

Nested Schema : inputs

Type: object

Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.

Back to Top

Response

201 Response

Back to Top