TrieOH
IdentityXAPIActors

Create a project actor

Creates an actor in the project (used by services that provision project identities — e.g. a workspace API key holder creating a service actor). The authenticated actor must be a platform-level client.

POST/projects/{project_id}/actors

Creates an actor in the project (used by services that provision project identities — e.g. a workspace API key holder creating a service actor). The authenticated actor must be a platform-level client.

Authorization

AuthorizationBearer <token>

JWT issued by IdentityX, signed with Ed25519

In: header

Path Parameters

project_id*string

Project ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for actor creation. Mirrors models.CreateActorRequest.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/actors" \  -H "Content-Type: application/json" \  -d '{    "auth_method": "api_key",    "type": "service",    "email": "checkout@example.com"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "auth_method": "password",
  "verified_at": "2019-08-24T14:15:22Z",
  "email": "user@example.com",
  "type": "human",
  "metadata": {},
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 400,
  "title": "Validation Failed"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 401,
  "title": "Unauthenticated"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 404,
  "title": "Not Found"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 500,
  "title": "Internal Server Error"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 503,
  "title": "Identity Unavailable"
}

List project actors GET

Lists the actors registered in the project. The authenticated actor must be a user or member of the project (project-scoped service accounts included). Never public.

Get a project actor by ID GET

Fetches a single actor from the project by ID. The authenticated actor must be a user or member of the project (project-scoped service accounts included). Never public.