SPA Credentials

SPA: Retrieves a paginated list of Credentials

Returns a paginated list of credentials for the authenticated user's client.

GET/api/spa/credentials

SPA: Retrieves a paginated list of Credentials

curl --request GET \
  --url 'https://app.output.rocks/api/spa/credentials?page=1&itemsPerPage=20&order%5Bid%5D=asc&order%5Bidentifier%5D=asc&order%5BactiveFrom%5D=asc&order%5Bactive%5D=asc&order%5Bencrypted%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

[
  {
    "id": 12345,
    "identifier": "api_key_production",
    "encrypted": true,
    "value": "secret_value",
    "createdAt": "2024-08-23T00:00:00+00:00",
    "updatedAt": "2024-08-23T00:00:00+00:00",
    "active": true,
    "activeFrom": "2024-01-01",
    "subClientDefault": false,
    "subClientId": 3,
    "subClientDescription": "Branch Office A"
  }
]

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

page

integerdefault:1

The collection page number

itemsPerPage

integerdefault:20

The number of items per page

pagination

boolean

Enable or disable pagination

order[id]

stringdefault:asc

No description provided.

order[identifier]

stringdefault:asc

No description provided.

order[activeFrom]

stringdefault:asc

No description provided.

order[active]

stringdefault:asc

No description provided.

order[encrypted]

stringdefault:asc

No description provided.

order[createdAt]

stringdefault:asc

No description provided.

order[updatedAt]

stringdefault:asc

No description provided.

string

Search across multiple fields (id, identifier, encrypted, activeFrom, active, createdAt, updatedAt, subClient.description) using OR logic with partial matching.

identifier

string

No description provided.

encrypted

boolean

No description provided.

active

boolean

No description provided.

activeFrom[before]

string

No description provided.

activeFrom[strictly_before]

string

No description provided.

activeFrom[after]

string

No description provided.

activeFrom[strictly_after]

string

No description provided.

Response

200application/json

Credential collection

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"

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"