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.
/projects/{project_id}/actorsCreates 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.
JWT issued by IdentityX, signed with Ed25519
In: header
Path Parameters
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/json
application/json
application/json
application/json
application/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" }'{
"code": 200,
"message": "string",
"error": {
"code": "BAD_REQUEST",
"message": "string",
"fields": [
{
"field": "string",
"message": "string"
}
],
"meta": {},
"debug": {
"raw_error": "string",
"stack_trace": "string"
}
},
"pagination": {
"page": 1,
"limit": 1,
"total": 0,
"has_next": true,
"has_prev": true,
"next_page": 0,
"prev_page": 0
},
"timestamp": "2019-08-24T14:15:22Z",
"module": "string",
"data": {
"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"
}
}{
"code": 0,
"message": "string",
"error": {
"code": "BAD_REQUEST",
"message": "string",
"fields": [
{
"field": "string",
"message": "string"
}
],
"meta": {},
"debug": {
"raw_error": "string",
"stack_trace": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"module": "IdentityX"
}{
"code": 0,
"message": "string",
"error": {
"code": "BAD_REQUEST",
"message": "string",
"fields": [
{
"field": "string",
"message": "string"
}
],
"meta": {},
"debug": {
"raw_error": "string",
"stack_trace": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"module": "IdentityX"
}{
"code": 0,
"message": "string",
"error": {
"code": "BAD_REQUEST",
"message": "string",
"fields": [
{
"field": "string",
"message": "string"
}
],
"meta": {},
"debug": {
"raw_error": "string",
"stack_trace": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"module": "IdentityX"
}{
"code": 0,
"message": "string",
"error": {
"code": "BAD_REQUEST",
"message": "string",
"fields": [
{
"field": "string",
"message": "string"
}
],
"meta": {},
"debug": {
"raw_error": "string",
"stack_trace": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"module": "IdentityX"
}{
"code": 0,
"message": "string",
"error": {
"code": "BAD_REQUEST",
"message": "string",
"fields": [
{
"field": "string",
"message": "string"
}
],
"meta": {},
"debug": {
"raw_error": "string",
"stack_trace": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"module": "IdentityX"
}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.