Skip to main content

UserSuccession

Read-only survey of every resource the departing account would need to hand off — sole-owned resources plus Pipelines it runs as — with, per resource, up to 5 ranked candidates to hand it to. The actual transfer is a later step; this endpoint writes nothing.

user_idUser Id (string)required
totalTotal (integer)

Possible values: >= 0

Default value: 0
truncatedTruncated (boolean)
Default value: false
collections object[]
  • Array [
  • collection_id object
    anyOf
    string
    collection_name object
    anyOf
    string
    resources object[]
  • Array [
  • resource_typeResource Type (string)required
    resource_idResource Id (string)required
    name object
    anyOf
    string
    sole_ownerSole Owner (boolean)
    Default value: false
    run_asRun As (boolean)
    Default value: false
    candidates object[]
  • Array [
  • subject_idSubject Id (string)required
    name object
    anyOf
    string
    categoryCategory (string)required

    Possible values: [user, service_account]

    scoreScore (integer)required
    reasonsstring[]
    granted_at object
    anyOf
    integer
    needs_collection_roleNeeds Collection Role (boolean)
    Default value: false
  • ]
  • candidates_totalCandidates Total (integer)
    Default value: 0
  • ]
  • ]
  • UserSuccession
    {
    "user_id": "string",
    "total": 0,
    "truncated": false,
    "collections": [
    {
    "collection_id": "string",
    "collection_name": "string",
    "resources": [
    {
    "resource_type": "string",
    "resource_id": "string",
    "name": "string",
    "sole_owner": false,
    "run_as": false,
    "candidates": [
    {
    "subject_id": "string",
    "name": "string",
    "category": "user",
    "score": 0,
    "reasons": [
    "string"
    ],
    "granted_at": 0,
    "needs_collection_role": false
    }
    ],
    "candidates_total": 0
    }
    ]
    }
    ]
    }