cancel-invite

dci cancel-invite id [flags]

Marks the invite as Cancelled and invalidates the invite token so any outstanding email links stop working. The invite document is retained (soft cancel) — the user row remains visible in GET /iam/v1/users with inviteStatus: Cancelled. Use DELETE /iam/v1/users/\{id\} to fully remove the record.

Returns 404 if no invite exists for the given ID, and 409 if the invite is already cancelled.

Requires usersManager permission.

Request

Content-Type: application/json

Schema

{
  "type": "object"
}

Flags

--dry-run: (boolean default:false)

Output

OK - Invite cancelled.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

Field	Type	Description
message	string	Success message
inviteId	string	The invite document ID.

Raw JSON schema

{
  "type": "object",
  "description": "Response confirming invite cancellation.",
  "required": [
    "message",
    "inviteId"
  ],
  "properties": {
    "message": {
      "type": "string",
      "description": "Success message"
    },
    "inviteId": {
      "type": "string",
      "description": "The invite document ID."
    }
  }
}

Errors

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status	Exit code	Error code	Meaning
400	30	VALIDATION_ERROR	The arguments or request body were rejected. Review the command's flags and payload.
401	10	AUTHENTICATION_FAILED	Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
403	11	PERMISSION_DENIED	The DoiT user or the active customer context does not have access.
404	20	RESOURCE_NOT_FOUND	The requested resource does not exist. Check the identifier argument.
409	21	RESOURCE_CONFLICT	The operation conflicts with the resource's current state.
500	40	API_SERVER_ERROR	The API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: cancelinvite