Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Existing Atlas integration connection with explicit api:connect plus appropriate native domain grants. atlas_ingest_ and browser cookies are not accepted.

Headers

X-Workspace-Id
string<uuid>
required

Selector within saved grants and current issuer authority; never grants authority.

Idempotency-Key
string<uuid>
required

Retain the exact key and body across retries and transports.

Path Parameters

groupId
string<uuid>
required

Body

application/json
subject
object
required
valid_from
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)))$
reason
string
required
Required string length: 1 - 2000
request_key
string<uuid>
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)$
valid_to
string<date-time> | null
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)))$
is_primary
boolean
default:false
fte_weight
number
default:1
Required range: x <= 1
member_state
enum<string>
default:active
Available options:
active,
on_leave,
in_training,
ramping

Response

Authorized native result. Configuration success does not establish operational readiness.

outcome
any
required
replayed
boolean
required
request_key
string<uuid>
required
record_id
string<uuid>
required
request
object
required

Immutable original actor, person, kind, parent and configuration evidence.

record
object
required

Current native group or membership row; the original request is retained separately.