Skip to main content
PATCH
Rename or narrow an owned active credential

Authorizations

Authorization
string
header
required

Opaque user-bound ca_ account credential. Each request checks live account scopes, verified email, expiry, revocation and the issuer session. Not a workspace ck_ key or OAuth access token.

Headers

Origin
string<uri>

Required for cookie authentication: an exact trusted application origin configured by the server. Bearer requests do not require Origin.

Path Parameters

credentialId
string<uuid>
required

Body

application/json

Provide at least one of name, scopes or expiresAt, plus password. Scopes must be a subset of the current scopes; expiry must be future and no later than the current expiry.

password
string<password>
required
write-only
Required string length: 1 - 1024
name
string
Required string length: 5 - 300
scopes
enum<string>[]
Required array length: 1 - 20 elements
Available options:
workspaces:read,
workspaces:write,
workspaces:manage,
members:read,
members:write,
teams:read,
teams:write,
invites:accept,
agents:read,
agents:write,
sources:read,
sources:write,
learnings:read,
learnings:write,
grill:read,
grill:write,
notifications:read,
notifications:write,
credentials:read,
credentials:write
expiresAt
string<date-time>

Future expiry no later than the existing credential expiry.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

Rename or narrow an owned active credential

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
name
string
required
Required string length: 5 - 300
prefix
string
required
scopes
enum<string>[]
required
Required array length: 1 - 20 elements
Available options:
workspaces:read,
workspaces:write,
workspaces:manage,
members:read,
members:write,
teams:read,
teams:write,
invites:accept,
agents:read,
agents:write,
sources:read,
sources:write,
learnings:read,
learnings:write,
grill:read,
grill:write,
notifications:read,
notifications:write,
credentials:read,
credentials:write
expiresAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
audience
string
required
Allowed value: "https://app.communicate.so/api/v1"
revokedAt
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
rotatedFromId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$