Secret

Secret
Secret

A re-usable secret identified by a ordId, projectId and name.

JSON Example
{
    "orgId": "string",
    "projectId": "string",
    "projectIds": [
        "string"
    ],
    "projectName": "string",
    "id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "name": "my-name",
    "description": "string",
    "value": "my-value",
    "orgScoped": false,
    "createdBy": "exampleuser",
    "updatedBy": "exampleuser",
    "createdAt": "2019-09-16 09:25:38.065065+00",
    "updatedAt": "2019-09-16 09:25:38.065065+00"
}
string
orgId
Optional

The id of organization the secret belongs to. Can not be modified, only available in response.

string
projectId
Optional

The id of project the secret belongs to. Provided during create, can not be updated.

array of string
projectIds
Optional

IDs of projects, associated with the secret. This is not a full list and is limited to 10 projects.

string
projectName
Optional

The name of project the secret belongs to.

string
id
Optional

The unique identifier of a secret.

string
name
Required
Constraints: minLength: 0 maxLength: 255

A human-friendly name used as an identifier for a secret.

string
description
Optional

A human-friendly description.

string
value
Required
Constraints: minLength: 0 maxLength: 131072

The value of secret.

boolean
orgScoped
Optional

To check if the secret is a org scope or project scope

string
createdBy
Optional

The user that created this secret. Can not be modified. only available in response.

string
updatedBy
Optional

The user that last updated this secret. Can not be modified. only available in response.

string
createdAt
Optional

Date when the secret was created. The date is in ISO 8601 with time zone Can not be modified. only available in response.

string
updatedAt
Optional

Date when the secret was last updated. The date is in ISO 8601 with time zone. Can not be modified. only available in response.

Property Of
Returned By