# 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

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

tenant_authorizations_list

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}

tenant_authorizations_retrieve

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}

tenant_authorizations_update

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**

### GET /api/v3/beta/users

users_list

Return a list of users

> **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 |
| --- | --- | --- | --- | --- |
| filter[email] | query | string | no |  |
| filter[email][ne] | query | string | no |  |
| filter[first_name] | query | string | no |  |
| filter[first_name][ne] | query | string | no |  |
| filter[id] | query | string | no |  |
| filter[is_active] | query | string | no |  |
| filter[is_active][ne] | query | string | no |  |
| filter[last_login] | query | string | no |  |
| filter[last_login][gt] | query | string | no |  |
| filter[last_login][gte] | query | string | no |  |
| filter[last_login][lt] | query | string | no |  |
| filter[last_login][lte] | query | string | no |  |
| filter[last_login][ne] | query | string | no |  |
| filter[last_name] | query | string | no |  |
| filter[last_name][ne] | query | string | no |  |
| 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> |
| sort | query | array of string (email | -email | first_name | -first_name | last_name | -last_name | is_active | -is_active | last_login | -last_login) | no | Which field to use when ordering the results. |

**Example request**

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

**Response 200**

```json
{
  "data": {
    "type": "tenant_authorizations",
    "id": "EgRsU4QmZ0Cw0WeM",
    "attributes": {
      "role": "admin"
    },
    "relationships": {
      "user": {
        "data": {
          "type": "users",
          "id": "o2iIHabAH9K3WgEI"
        }
      },
      "tenant": {
        "data": {
          "type": "tenants",
          "id": "0016u00000WEsQR"
        }
      }
    },
    "links": {
      "self": "https://api.cradlepointecm.com/api/v3/beta/tenant_authorizations/EgRsU4QmZ0Cw0WeM"
    }
  }
}
```

### POST /api/v3/beta/users

users_create

Create a user

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

**Request body**

**Example request**

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

**Response 201**

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

users_retrieve

Get a single user

> **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/users/{id}" \
  -H "Authorization: Bearer <token>"
```

**Response 200**

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

users_update

Update an existing user

> **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/users/{id}" \
  -H "Authorization: Bearer <token>"
```

**Response 200**

```json
{
  "data": {
    "type": "tenant_authorizations",
    "id": "DgAS6GWwPy6d3wRJ",
    "attributes": {
      "role": "user"
    },
    "relationships": {
      "user": {
        "data": {
          "type": "users",
          "id": "OTES06d2woaWeOKY"
        }
      },
      "tenant": {
        "data": {
          "type": "tenants",
          "id": "0016u00000WEsQR"
        }
      }
    },
    "links": {
      "self": "https://api.cradlepointecm.com/api/v3/beta/tenant_authorizations/DgAS6GWwPy6d3wRJ"
    }
  }
}
```

### DELETE /api/v3/beta/users/{id}

users_destroy

Delete a user

> **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 -X DELETE "https://api.cradlepointecm.com/api/v3/beta/users/{id}" \
  -H "Authorization: Bearer <token>"
```

**Response 204** — No response body