# Add a member

## `POST /v1/members`

Adds a new member to the organization with the specified roles.

### Header parameters

- `Authorization` (string, required): `Bearer <token>`. [Authentication](https://spice.ai/docs/cloud/api/management#authentication) lists the tokens it accepts.
- `X-Org-Name` (string, optional): The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but `GET /v1/orgs` (400 `org_assertion_required` otherwise). Pattern: `^[A-Za-z0-9._-]{1,255}$`.

### Request body

Required.

Content type: `application/json`

- `username` (string, required): The username of the user to add
- `roles` (array of string): Roles to assign to the new member. Default: `["member"]`.

### Example request

```bash
curl -X POST "https://api.spice.ai/v1/members" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "string"
  }'
```

```http
POST /v1/members HTTP/1.1
Host: api.spice.ai
Authorization: Bearer <token>
Content-Type: application/json
Content-Length: 26

{
  "username": "string"
}
```

### Responses

**201 Created**

Member added successfully

Content type: `application/json`

- `user_id` (integer)
- `username` (string)
- `roles` (array of string)
- `created_at` (string (date-time))

**400 Bad Request**

Invalid request body

**401 Unauthorized**

Unauthorized

**403 Forbidden**

Insufficient scope, not an org admin/owner, or only owners can assign the admin or owner role

**404 Not Found**

User not found

**409 Conflict**

User is already a member of this organization

## `POST /v1/orgs/{orgId}/members`

The org is `orgId` in the path. Adds a new member to the organization with the specified roles.

### Path parameters

- `orgId` (integer, required): The org id from GET /v1/orgs. Minimum: `1`.

### Header parameters

- `Authorization` (string, required): `Bearer <token>`. [Authentication](https://spice.ai/docs/cloud/api/management#authentication) lists the tokens it accepts.
- `X-Org-Name` (string, optional): When present, X-Org-Name must name the same org as orgId. Otherwise the request returns org\_path\_mismatch (400). Pattern: `^[A-Za-z0-9._-]{1,255}$`.

### Request body

Required.

Content type: `application/json`

- `username` (string, required): The username of the user to add
- `roles` (array of string): Roles to assign to the new member. Default: `["member"]`.

### Example request

```bash
curl -X POST "https://api.spice.ai/v1/orgs/<orgId>/members" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "string"
  }'
```

```http
POST /v1/orgs/<orgId>/members HTTP/1.1
Host: api.spice.ai
Authorization: Bearer <token>
Content-Type: application/json
Content-Length: 26

{
  "username": "string"
}
```

### Responses

**201 Created**

Member added successfully

Content type: `application/json`

- `user_id` (integer)
- `username` (string)
- `roles` (array of string)
- `created_at` (string (date-time))

**400 Bad Request**

Invalid request body. orgId is not a valid org id (`invalid_org_id`), or X-Org-Name does not name that org (`org_path_mismatch`).

**401 Unauthorized**

Unauthorized

**403 Forbidden**

Insufficient scope, not an org admin/owner, or only owners can assign the admin or owner role. The caller is not a member of the org (`org_forbidden`). A machine credential named a different org (`org_assertion_mismatch`). The org is deleted (`org_deleted`).

**404 Not Found**

User not found

**409 Conflict**

User is already a member of this organization

OpenAPI: [api.spice.ai/openapi.json](https://api.spice.ai/openapi.json)