{ "id": 123, "email": "user@example.com", "roles": [ "string" ], "archiveAuditorScope": [ "string" ], "invalidRoleValues": [ "string" ], "adminNote": "string", "password": "string", "active": true, "lastLoginDate": "2024-08-23T00:00:00+00:00", "previousLoginDate": "2024-08-23T00:00:00+00:00", "releaseNotesDate": "2024-08-23T00:00:00+00:00", "authCode": "string", "locale": "en", "signature": "string", "sharePointEmail": "user@example.com", "client": {}, "subClient": {}, "createdBy": "user1@company.com", "updatedBy": "user1@company.com", "createdAt": "2024-08-23T00:00:00+00:00", "updatedAt": "2024-08-23T00:00:00+00:00", "userIdentifier": "string", "ssoRoles": [ "string" ], "emailAuthEnabled": true, "emailAuthRecipient": "user@example.com", "emailAuthCode": "user@example.com", "subClientId": 3, "subClientDescription": "Branch Office A", "subClientColor": "#083E5D" }

SPA Users

SPA: Retrieves a single User

Returns a single user by ID. Requires ROLE_ADMIN.

GET/api/spa/users/{id}

SPA: Retrieves a single User

curl --request GET \
  --url 'https://app.output.rocks/api/spa/users/string' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

{
  "id": 123,
  "email": "user@example.com",
  "roles": [
    "string"
  ],
  "archiveAuditorScope": [
    "string"
  ],
  "invalidRoleValues": [
    "string"
  ],
  "adminNote": "string",
  "password": "string",
  "active": true,
  "lastLoginDate": "2024-08-23T00:00:00+00:00",
  "previousLoginDate": "2024-08-23T00:00:00+00:00",
  "releaseNotesDate": "2024-08-23T00:00:00+00:00",
  "authCode": "string",
  "locale": "en",
  "signature": "string",
  "sharePointEmail": "user@example.com",
  "client": {},
  "subClient": {},
  "createdBy": "user1@company.com",
  "updatedBy": "user1@company.com",
  "createdAt": "2024-08-23T00:00:00+00:00",
  "updatedAt": "2024-08-23T00:00:00+00:00",
  "userIdentifier": "string",
  "ssoRoles": [
    "string"
  ],
  "emailAuthEnabled": true,
  "emailAuthRecipient": "user@example.com",
  "emailAuthCode": "user@example.com",
  "subClientId": 3,
  "subClientDescription": "Branch Office A",
  "subClientColor": "#083E5D"
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Path Parameters

stringrequired

User identifier

Response

200application/json

User resource

integer

string<email>

roles

string | null[]

archiveAuditorScope

string | null[] | null

Bounded archive read grant. A missing grant never authorizes ROLE_ARCHIVE_AUDITOR.

invalidRoleValues

string | null[]

adminNote

string | null

password

string

active

boolean

Available options: truefalse

Example: true

lastLoginDate

string<date-time> | null

previousLoginDate

string<date-time> | null

releaseNotesDate

string<date-time> | null

authCode

string | null

locale

string

Example: "en"

signature

string | null

Personal signature image (base64 encoded PNG, without data-URI prefix).

sharePointEmail

string | null

Microsoft 365 account email used for SharePoint document editing when it differs from the application login email.

client

object

subClient

object

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"

userIdentifier

string

A visual identifier that represents this user.

ssoRoles

string | null[]

Keep the locally administered support permission independent of IdP roles.

emailAuthEnabled

boolean

Available options: truefalse

emailAuthRecipient

string

emailAuthCode

string

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"

subClientColor

string

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

Example: "#083E5D"