# tenant authorizations — NCM API

Beta. Which users and collaborators can reach the account tenant, and whether each holds 'user' or 'admin' permission, admin being the Add/Edit User right. Full lifecycle across both the authorizations and the users they refer to. For per-account rather than per-tenant roles, see account authorizations.

Base URL: https://api.cradlepointecm.com

## Authentication

This is a v3 endpoint (`/api/v3/` path). Send a Bearer token on every request:

```http
Authorization: Bearer <token>
```

Tokens are generated in the NCM UI under API Keys. The v2 and v3 auth schemes are NOT interchangeable: v2 API-key headers are rejected on v3 endpoints.

### GET /api/v3/beta/tenant_authorizations

Get tenant authorizations

Return a list of tenant authorizations

> **Beta:** This endpoint is served on a `/beta/` path. Beta endpoints are still evolving and may change without the stability guarantees of GA endpoints.

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| page[after] | query | string | no | Cursor for next page. |
| page[before] | query | string | no | Cursor for prior page. |
| page[size] | query | integer | no | Number of results to return per page. |
| search | query | string | no | The search query param performs a case insensitive substring search on a set of fields. <br> A record matches if any search field matches the search text. <br>If the search param doesn't include a field list, the server selects the fields. <br>Example:<ul><li>Search by substring: `search=substring1,substring2` </li><li>Search by field(s) and substring: `search[fieldA,fieldB]=substring1,substring2,substring3` </li><ul> |

**Example request**

```bash
curl "https://api.cradlepointecm.com/api/v3/beta/tenant_authorizations" \
  -H "Authorization: Bearer <token>"
```

**Response 200**

### GET /api/v3/beta/tenant_authorizations/{id}

Get tenant authorizations by ID

Get a single tenant authorization

> **Beta:** This endpoint is served on a `/beta/` path. Beta endpoints are still evolving and may change without the stability guarantees of GA endpoints.

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| id | path | string | yes |  |

**Example request**

```bash
curl "https://api.cradlepointecm.com/api/v3/beta/tenant_authorizations/{id}" \
  -H "Authorization: Bearer <token>"
```

**Response 200**

### PUT /api/v3/beta/tenant_authorizations/{id}

Update tenant authorizations by ID

Update an existing tenant authorization

> **Beta:** This endpoint is served on a `/beta/` path. Beta endpoints are still evolving and may change without the stability guarantees of GA endpoints.

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| id | path | string | yes |  |

**Request body**

**Example request**

```bash
curl -X PUT "https://api.cradlepointecm.com/api/v3/beta/tenant_authorizations/{id}" \
  -H "Authorization: Bearer <token>"
```

**Response 200**