Skip to main content
  1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. AgentClaimResponse

AgentClaimResponse

    Describes an agent account being claimed: the agent itself, the inventory of Pulumi entities it owns in the source organization, and the conflicts or failures that prevent the claim from completing. Preview and commit share this shape so the UI can render the same view for both.

    Properties

    • agent AgentAccountSummary required
      Identity and metadata for the agent account being claimed.
    • login string required
      The agent user’s Pulumi login (e.g. “agent-abc123”). This is what pulumi whoami returns while the agent’s access token is in use.
    • orgName string required
      Slug of the agent’s individual organization. This appears in the // identity of any stack the agent created.
    • createdAt string required
      When the agent account was created (i.e. when /api/agents/signup ran).
    • entities array[TransferEntity] required
      Inventory of Pulumi entities owned by the agent in the source organization. If the claim completes, these transfer to the destination organization. A non-empty conflicts or failures list prevents the claim from completing.
    • kind string required
    • conflicts array[TransferEntity] required
      Name collisions with the destination organization that the client can resolve by supplying conflictsResolution in a follow-up request. Both preview and a blocked commit return 200 with this body populated; the commit does not mutate state when any conflict is present.
    • kind string required
    • failures array[TransferEntityFailure] required
      Entities the service cannot transfer (e.g. ESC environments and Insights accounts at launch, which have no transfer primitive yet). Unlike conflicts, failures are not user-resolvable.
    • entity TransferEntity required
      The reference of the entity that cannot be transferred.
    • failureDetails string required
      Service-side reason the entity cannot be transferred.
    • claimExpiresAt string required
      When the claim window closes. After this time the claim token expires and the claim cannot complete.
    • transferToken string optional
      On successful start of a claim, the token needed to check for progress.