# Add a user directly to a project POST /v1/projects/{projectId}/memberships ```sh curl --request POST \ --url https://example.com/v1/projects/example/memberships \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "userId": "example", "email": "example", "role": "viewer" }' ``` Names the person by exactly one of `userId` and `email` (matched as the runtime matches emails when it adds a person); someone who is not a person of this tenant, or was removed from it, is refused with 404 `identity-user-not-found`. Adding a role the member already holds answers 201 with the existing record; another role, 409 `membership-exists` naming the role they hold (`details.role`), which is kept: use PATCH to change it. ## Authorizations - **[bearerAuth](https://docs.kindgi.com/v0.1.9/reference/api.md#bearerauth)** ## Parameters ### Path Parameters **projectId** required string ProjectId — opaque branded string. ### Header Parameters **Idempotency-Key** string \>= 1 characters Caller-supplied idempotency key, scoped to the caller: the same key from someone else in the tenant is their own request (from 0.1.5). Retries with the same key return the original response byte-identical (per `docs/API-ROUTE-CONVENTIONS.md` §3.1). A retry sent while the first request still runs is answered `409 idempotency-key-in-flight` with `Retry-After`, on a runtime whose store holds keys (from 0.1.5); retry after it, and you get the first request’s answer. An answer that carries a secret (a new API key or public run token, a session token, a generated signing secret) isn’t kept: a retry gets `409 idempotency-key-replay-withheld`, with the first request’s status and when it succeeded (from 0.1.5). ## Request Bodyrequired application/json Exactly one of `userId` and `email` names the person. object **userId** string \>= 1 characters **email** The person’s email, as the tenant has it. string \>= 1 characters **role** required A role to give on a project: `owner`, `admin`, `editor` or `viewer`, each including the ones after it. `member` is refused (400): give `viewer`. string Allowed values: viewer editor owner admin ## Responses ### 201 Membership added. application/json object **projectId** required string **userId** required string **role** required Role on a project, as read. `member` is only read, on a role given before it was retired: it grants what `viewer` does, and writes refuse it. string Allowed values: viewer editor owner admin member ##### Example ```json { "role": "viewer" } ``` ### 400 Malformed request body. application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 401 Missing / malformed / expired / revoked bearer token. application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 403 The person is one a site signs in, who holds only the grants their site’s sign-in writes (`site-person-grants-managed`). application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 404 No project with that id under this tenant (`project-not-found`), or the person named is not a member of this tenant (`identity-user-not-found`). application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 409 A member already, with another role (`membership-exists`, `details.role`); or an Idempotency-Key reused with another body. application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 413 The request body is over the API’s limit (`request-too-large`; `details.maxBytes` says how much). application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 500 Server error (unmapped domain code or framework crash). application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ## See also - [`GET /v1/projects/{projectId}/memberships`: List direct memberships of a project](https://docs.kindgi.com/v0.1.9/reference/api/operations/projectsmembershipslist.md) - [`GET /v1/projects/{projectId}`: Fetch a project by id](https://docs.kindgi.com/v0.1.9/reference/api/operations/projectsget.md) - [`PATCH /v1/projects/{projectId}`: Partially update a project](https://docs.kindgi.com/v0.1.9/reference/api/operations/projectsupdate.md) - [`DELETE /v1/projects/{projectId}`: Delete a project (idempotent)](https://docs.kindgi.com/v0.1.9/reference/api/operations/projectsdelete.md) - [Error code `identity-user-not-found`](https://docs.kindgi.com/v0.1.9/reference/errors.md#identity-user-not-found) - [Error code `membership-exists`](https://docs.kindgi.com/v0.1.9/reference/errors.md#membership-exists) - [Error code `project-not-found`](https://docs.kindgi.com/v0.1.9/reference/errors.md#project-not-found) - [Error code `request-too-large`](https://docs.kindgi.com/v0.1.9/reference/errors.md#request-too-large) - [Error code `site-person-grants-managed`](https://docs.kindgi.com/v0.1.9/reference/errors.md#site-person-grants-managed) - [Every error code](https://docs.kindgi.com/v0.1.9/reference/errors.md)