SPA Credentials

SPA: Updates a Credential

Updates an existing credential.

PATCH/api/spa/credentials/{id}

Authorizations

X-AUTH-TOKEN
stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Path Parameters

id
stringrequired

Credential identifier

Request Body

application/json
required

The updated Credential resource

{
  "identifier": "api_key_production",
  "encrypted": true,
  "value": "secret_value",
  "subClient": {},
  "active": true,
  "activeFrom": "2024-01-01",
  "subClientDefault": false
}

Response

200application/json

Credential resource updated

id
integer

Identifier generated by Output.Rocks.

Example: 12345

identifier
stringrequired

Unique identifier for the credential

Example: "api_key_production"

encrypted
boolean

Whether the value is encrypted

Available options: truefalse

Example: true

value
stringrequired

The credential value (masked if encrypted)

Example: "secret_value"

createdBy
string

User, created this entry

Example: "user1@company.com"

updatedBy
string

User, updated this entry

Example: "user1@company.com"

createdAt
string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt
string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"

active
boolean

Active flag. Default: true

Available options: truefalse

Example: true

activeFrom
string<date-time>

Date to activate the entry. Default: today

Example: "2024-01-01"

subClientDefault
boolean

Default for environmental tenants (sub-clients)

Available options: truefalse

Example: false

subClientId
integer

SubClient ID. Provided on instances with enabled sub-client module only.

Example: 3

subClientDescription
string

SubClient description. Provided on instances with enabled sub-client module only.

Example: "Branch Office A"