Skip to main content
Lists the identities you can spawn an agent as in the current tenant: your own developer identity and any service profiles you are allowed to borrow. Each entry reports whether it is usable right now and, if not, why and how to fix it. Use it before spawn to discover what to pass to the service_profile parameter. Profiles you cannot assume are omitted. This is the discovery companion to spawning under a service profile. To inspect every defined profile — including ones you cannot borrow — read the service-profile catalog resource, for example with murmur get service-profile.

Parameters

This tool takes no parameters.

Response

Returns an array of identity entries.
FieldTypeDescription
typestringself for your own developer identity, or service_profile for a borrowable service profile.
accountstringThe identity’s account. For a service_profile entry, pass this to spawn’s service_profile parameter to spawn under it. The self entry reports your own account (identifying who “self” is); to spawn as yourself, leave service_profile empty rather than passing the account.
usablebooleanWhether this identity can be used to spawn right now.
blocksobject[]Present only when usable is false. Each entry has a reason (what is unmet) and a remediation (how to fix it).
descriptionstringThe profile’s description. Populated for service profiles.
builtinbooleantrue for platform-provided profiles.
For your own identity (self), the usable verdict is advisory — the server cannot see the credentials on your local machine, so a spawn as self may still succeed even when self is reported as blocked.

Examples

List spawn identities

{}
Response:
[
  {
    "type": "self",
    "account": "acme-dev",
    "usable": true
  },
  {
    "type": "service_profile",
    "account": "ci-builder",
    "usable": true,
    "description": "Opens PRs as the CI bot",
    "builtin": false
  },
  {
    "type": "service_profile",
    "account": "release-manager",
    "usable": false,
    "description": "Cuts release branches",
    "blocks": [
      {
        "reason": "missing service-profile.assume permission",
        "remediation": "ask an admin to grant you service-profile.assume on release-manager"
      }
    ]
  }
]

Spawn under a discovered profile

After confirming ci-builder is usable, pass its account to spawn:
{
  "slug": "nightly-build",
  "description": "Run the nightly build and open a PR with the results",
  "workspace": "ci",
  "service_profile": "ci-builder"
}

Errors

CodeMeaningWhat to do
UNAUTHENTICATEDIdentity token is missing or expired.Check the host’s credentials.