TrieOH
IdentityXAPIProjects

Upsert a project's email template override

Saves the project's override for one kind. The body is a Go template rendered with the same variables as the built-in defaults: `ActionURL`, `ProjectName`, `Expiry`, `ProjectDomain`, `Email`. The body must reference `{{.ActionURL}}` at least once (the actionable link always comes from IdentityX) and must render; violations are rejected with 422-style validation errors. The authenticated actor must be an admin or owner of the project.

PUT/projects/{project_id}/email-templates/{kind}

Saves the project's override for one kind. The body is a Go template rendered with the same variables as the built-in defaults: ActionURL, ProjectName, Expiry, ProjectDomain, Email. The body must reference {{.ActionURL}} at least once (the actionable link always comes from IdentityX) and must render; violations are rejected with 422-style validation errors. The authenticated actor must be an admin or owner of the project.

Authorization

AuthorizationBearer <token>

JWT issued by IdentityX, signed with Ed25519

In: header

Path Parameters

project_id*string

Project ID.

kind*string

Email template kind.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for PUT /projects/{project_id}/email-templates/{kind}.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/email-templates/verify" \  -H "Content-Type: application/json" \  -d '{    "subject": "Welcome to Acme — confirm your email",    "body": "<p>Hi there!</p>\\n<p><a href=\\"{{.ActionURL}}\\">Confirm my email</a></p>\\n"  }'
{
  "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": {
    "kind": "verify",
    "subject": "string",
    "body": "string",
    "source": "default"
  }
}
{
  "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"
}
{
  "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"
}

Delete a project's email template override DELETE

Removes the project's override for one kind, restoring the built-in default. Deleting a kind that has no override is a no-op. The authenticated actor must be an admin or owner of the project.

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.