Skip to main content
POST
Create a one-time Service Identity M2M client secret

Authorizations

Authorization
string
header
required

Account Service Key, prefixed with pho_ask_, sent as Authorization: Bearer <key>. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted.

Headers

Idempotency-Key
string
required

Identifies one logical mutation across retries.

Required string length: 1 - 255
Pattern: ^[\x21-\x7e]{1,255}$

Path Parameters

organizationId
string
required
serviceIdentityId
string
required

Body

application/json
expectedIdentityVersion
string
required
Pattern: ^[1-9][0-9]{0,18}$
label
string
required
Required string length: 1 - 256

Response

Creation stage and state; only first delivery includes value and clientId.

clientId
string
required
Maximum string length: 256
Pattern: ^client_[A-Za-z0-9]+$
credentialId
string
required
Pattern: ^pho_scred_[0-7][0-9a-hjkmnp-tv-z]{25}$
stage
string
required
Allowed value: "credential"
status
string
required
Allowed value: "created"
value
string
required
Required string length: 1 - 8192