Deployments.ai Docs
System

Find the person or pending sign-up holding an email; matches the whole address

GET /v1/system/principals · SDK findSystemPrincipal · CLI deployments system people find

GET
/v1/system/principals

Requires platform:admin.

Authorization

tenantJwt
headerAuthorizationBearer <token>

Tenant JWT carrying organization, project, and environment claims.

Query Parameters

email*string

The person's email. Matches the whole normalized address only.

Length3 <= length <= 320

Response Body

FindSystemPrincipalResponse

application/json
  1. response

The person holding the email, or the sign-up waiting for that email to be verified.

kind*"person"
Value in"person"
person*
curl -X GET "https://example.com/v1/system/principals?email=string"
{  "kind": "person",  "person": {    "createdAt": "2019-08-24T14:15:22Z",    "displayName": "string",    "id": "string",    "kind": "human",    "platformRole": "administrator",    "primaryEmail": "string",    "status": "active",    "updatedAt": "2019-08-24T14:15:22Z"  }}