Skip to content
OTA-Pulse Docs

Start Support Access

POST
/api/support-access
 
curl --request POST \
  --url https://example.com/api/support-access \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "duration_minutes": 30, "organization_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "otp_code": "example", "reason": "example", "ticket": "example" }'

Open a read-only, time-boxed, audited view of one organization.

Authorizations

Section titled “ Authorizations ”

Request Bodyrequired

Section titled “ Request Bodyrequired ”
Media type application/json
SupportAccessStart
object
duration_minutes
Duration Minutes

<= settings.support_grant_max_minutes

integer
default: 30 >= 1
organization_id
required
Organization Id
string format: uuid
otp_code
required
Otp Code

Fresh TOTP code (MFA step-up)

string
>= 6 characters <= 10 characters
reason
required
Reason
string
>= 10 characters <= 500 characters
ticket
required
Ticket
string
>= 1 characters <= 255 characters

Responses

Section titled “ Responses ”

201

Section titled “ 201 ”

Successful Response

Media type application/json
SupportSessionStarted
object
actor_email
Any of:
string
actor_id
required
Any of:
string format: uuid
expires_at
required
Expires At
string format: date-time
id
required
Id
string format: uuid
organization_id
required
Organization Id
string format: uuid
read_only
Read Only
boolean
default: true
reason
required
Reason
string
revoked_at
required
Any of:
string format: date-time
started_at
required
Started At
string format: date-time
status
required
Status
string
ticket
required
Any of:
string
token_expires_at
required
Token Expires At
string format: date-time
Example 
{
  "read_only": true
}

422

Section titled “ 422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated 
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}