Skip to main content
GET
Describe a Service Account

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

service
string
required

Workspace Service ID

Response

WorkspaceServiceDetailedResponseData

id
string
required
Example:

"wssvc_01hq8xyzabc123def456ghi789"

state
enum<string>
required
Available options:
staged,
active,
expiring,
expired,
deactivated
environment
enum<string>
required
Available options:
demo,
sandbox,
development,
testing,
staging,
production,
unknown
name
string
required
handle
string
required
description
string | null
required
admin_notes
string | null
required
audit_notes
string | null
required
permission_notes
string | null
required
token_notes
string | null
required
ipv4_allowed
string[] | null
required
ipv6_allowed
string[] | null
required
timestamp
WorkspaceServiceNestedTimestampResponseData · object
required
count
WorkspaceServiceNestedCountResponseData · object
required
included
string[]
required
Minimum array length: 1

API hyperlinks related to the workspace service record