> For the complete documentation index, see [llms.txt](https://fusionauth.io/docs/llms.txt)

# Entity Type API

Learn about the APIs for creating, retrieving, updating and deleting entity types.

# Entity Type API

This feature is only available in paid plans. To learn more, see [our pricing page](https://fusionauth.io/pricing.md).

version

Available since version `1.26.0`

This page contains the APIs for managing Entity Types. Here are the APIs:

## Create an Entity Type

This API is used to create an Entity Type. Specifying an Id on the URI will instruct FusionAuth to use that Id when creating the Entity Type. Otherwise, FusionAuth will generate an Id for the Entity Type.

### Request

[!Global API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#global-api-key-authentication)

Create an Entity Type without providing an Id. An Id will be automatically generated.

POST/api/entity/type

OpenAPI Spec

[!Global API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#global-api-key-authentication)

Create an Entity Type with the provided Id

POST/api/entity/type/{entityTypeId}

OpenAPI Spec

#### Request Parameters

`entityTypeId`UUIDoptionalDefaults to secure random UUID

The Id to use for the new Entity Type. If not specified a secure random UUID will be generated.

#### Request Body

`entityType.data`Objectoptional

An object that can hold any information about the Entity Type that should be persisted.

`entityType.jwtConfiguration.accessTokenKeyId`UUIDoptional

The unique id of the signing key used to sign the access token.

Required when **enabled** is set to `true`.

`entityType.jwtConfiguration.enabled`BooleanoptionalDefaults to false

Indicates if this application is using the JWT configuration defined here or the global JWT configuration defined by the Tenant. If this is `false` the signing algorithm configured in the Tenant will be used. If `true` the signing algorithm defined in this application will be used.

`entityType.jwtConfiguration.timeToLiveInSeconds`Integeroptional

The length of time in seconds the JWT will live before it is expired and no longer valid.

Required when **enabled** is set to `true`.

`entityType.name`Stringrequired

A descriptive name for the entity type (i.e. "Customer" or "Email\_Service").

*Example Request JSON*

```json
{
  "entityType": {
    "name": "Customer",
    "data": {
      "createdBy": "jared@fusionauth.io"
    },
    "jwtConfiguration": {
      "accessTokenKeyId": "a7516c7c-6234-4021-b0b4-8870c807aeb2",
      "enabled": true,
      "timeToLiveInSeconds": 3600
    }
  }
}
```

### Response

The response for this API contains the information for the Entity Type that was created.

*Response Codes*

| Code | Description |
| --- | --- |
| 200 | The request was successful. The response will contain a JSON body. |
| 400 | The request was invalid and/or malformed. The response will contain an [Errors](https://fusionauth.io/docs/apis/errors.md) JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See [Authentication](https://fusionauth.io/docs/apis/authentication.md). |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
| 503 | The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body. |

#### Response Body

`entityType.data`Object

An object that can hold any information about the Entity Type that should be persisted.

`entityType.id`UUID

The Entity Type's unique Id.

`entityType.insertInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Entity Type was added to the FusionAuth database.

`entityType.jwtConfiguration.accessTokenKeyId`UUID

The unique id of the signing key used to sign the access token.

`entityType.jwtConfiguration.enabled`Boolean

Indicates if this application is using the JWT configuration defined here.

`entityType.jwtConfiguration.timeToLiveInSeconds`Integer

The length of time in seconds the JWT will live before it is expired and no longer valid.

`entityType.lastUpdateInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Entity Type was last updated in the FusionAuth database.

`entityType.name`Long

The name of the entity type (i.e. "Customer" or "Email\_Service").

`entityType.permissions`Array

An array of Permission objects.

`entityType.permissions[x].data`Object

An object that can hold any information about the Permission that should be persisted.

`entityType.permissions[x].description`String

A description of the Permission.

`entityType.permissions[x].id`UUID

The Id of the Permission.

`entityType.permissions[x].insertInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Permission was added to the FusionAuth database.

`entityType.permissions[x].isDefault`Boolean

Whether or not the Permission is default. A default Permission is automatically assigned to an Entity if no permissions are provided.

`entityType.permissions[x].lastUpdateInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Permission was last updated in the FusionAuth database.

`entityType.permissions[x].name`String

The name of the Permission.

*Example Response JSON for a Single Entity Type*

```json
{
  "entityType": {
    "data": {
      "createdBy": "jared@fusionauth.io"
    },
    "id": "8174f72f-5ecd-4eae-8de8-7fef597b3473",
    "insertInstant": 1595361142909,
    "jwtConfiguration": {
      "accessTokenKeyId": "a7516c7c-6234-4021-b0b4-8870c807aeb2",
      "enabled": true,
      "timeToLiveInSeconds": 3600
    },
    "lastUpdateInstant": 1595361143101,
    "name": "Customer",
    "permissions": [
      {
        "data": {
          "foo": "bar"
        },
        "id": "ce485a91-906f-4615-af75-81d37dc71e90",
        "insertInstant": 1595361142909,
        "isDefault": false,
        "lastUpdateInstant": 1595361143101,
        "name": "admin"
      },
      {
        "id": "ce485a91-906f-4615-af75-81d37dc71e91",
        "isDefault": true,
        "insertInstant": 1595361142911,
        "lastUpdateInstant": 1595361143111,
        "name": "user"
      }
    ]
  }
}
```

## Retrieve an Entity Type

This API is used to retrieve one or all of the configured Entity Types. Specifying an Id on the URI will retrieve a single Entity Type. Leaving off the Id will retrieve all of the Entity Types.

### Request

[!Global API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#global-api-key-authentication)

Retrieve all of the Entity Types

GET/api/entity/type

[!Global API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#global-api-key-authentication)

Retrieve a single Entity Type by Id

GET/api/entity/type/{entityTypeId}

OpenAPI Spec

#### Request Parameters

`entityTypeId`UUIDoptional

The Id of the Entity Type to retrieve.

### Response

The response for this API contains either a single Entity Type or all of the Entity Types. When you call this API with an Id the response will contain just that Entity Type. When you call this API without an Id the response will contain all of the Entity Types. Both response types are defined below along with an example JSON response.

*Response Codes*

| Code | Description |
| --- | --- |
| 200 | The request was successful. The response will contain a JSON body. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See [Authentication](https://fusionauth.io/docs/apis/authentication.md). |
| 404 | The object you requested doesn't exist. The response will be empty. |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
| 503 | The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body. |

#### Response Body

`entityType.data`Object

An object that can hold any information about the Entity Type that should be persisted.

`entityType.id`UUID

The Entity Type's unique Id.

`entityType.insertInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Entity Type was added to the FusionAuth database.

`entityType.jwtConfiguration.accessTokenKeyId`UUID

The unique id of the signing key used to sign the access token.

`entityType.jwtConfiguration.enabled`Boolean

Indicates if this application is using the JWT configuration defined here.

`entityType.jwtConfiguration.timeToLiveInSeconds`Integer

The length of time in seconds the JWT will live before it is expired and no longer valid.

`entityType.lastUpdateInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Entity Type was last updated in the FusionAuth database.

`entityType.name`Long

The name of the entity type (i.e. "Customer" or "Email\_Service").

`entityType.permissions`Array

An array of Permission objects.

`entityType.permissions[x].data`Object

An object that can hold any information about the Permission that should be persisted.

`entityType.permissions[x].description`String

A description of the Permission.

`entityType.permissions[x].id`UUID

The Id of the Permission.

`entityType.permissions[x].insertInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Permission was added to the FusionAuth database.

`entityType.permissions[x].isDefault`Boolean

Whether or not the Permission is default. A default Permission is automatically assigned to an Entity if no permissions are provided.

`entityType.permissions[x].lastUpdateInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Permission was last updated in the FusionAuth database.

`entityType.permissions[x].name`String

The name of the Permission.

*Example Response JSON for a Single Entity Type*

```json
{
  "entityType": {
    "data": {
      "createdBy": "jared@fusionauth.io"
    },
    "id": "8174f72f-5ecd-4eae-8de8-7fef597b3473",
    "insertInstant": 1595361142909,
    "jwtConfiguration": {
      "accessTokenKeyId": "a7516c7c-6234-4021-b0b4-8870c807aeb2",
      "enabled": true,
      "timeToLiveInSeconds": 3600
    },
    "lastUpdateInstant": 1595361143101,
    "name": "Customer",
    "permissions": [
      {
        "data": {
          "foo": "bar"
        },
        "id": "ce485a91-906f-4615-af75-81d37dc71e90",
        "insertInstant": 1595361142909,
        "isDefault": false,
        "lastUpdateInstant": 1595361143101,
        "name": "admin"
      },
      {
        "id": "ce485a91-906f-4615-af75-81d37dc71e91",
        "isDefault": true,
        "insertInstant": 1595361142911,
        "lastUpdateInstant": 1595361143111,
        "name": "user"
      }
    ]
  }
}
```

#### Response Body

`entityTypes[x]`Array

The list of EntityType objects.

`entityTypes[x].data`Object

An object that can hold any information about the Entity Type that should be persisted.

`entityTypes[x].id`UUID

The Entity Type's unique Id.

`entityTypes[x].insertInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Entity Type was added to the FusionAuth database.

`entityTypes[x].jwtConfiguration.accessTokenKeyId`UUID

The unique id of the signing key used to sign the access token.

`entityTypes[x].jwtConfiguration.enabled`Boolean

Indicates if this application is using the JWT configuration defined here.

`entityTypes[x].jwtConfiguration.timeToLiveInSeconds`Integer

The length of time in seconds the JWT will live before it is expired and no longer valid.

`entityTypes[x].lastUpdateInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Entity Type was last updated in the FusionAuth database.

`entityTypes[x].name`Long

The name of the entity type (i.e. "Customer" or "Email\_Service").

`entityTypes[x].permissions`Array

An array of Permission objects.

`entityTypes[x].permissions[x].data`Object

An object that can hold any information about the Permission that should be persisted.

`entityTypes[x].permissions[x].description`String

A description of the Permission.

`entityTypes[x].permissions[x].id`UUID

The Id of the Permission.

`entityTypes[x].permissions[x].insertInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Permission was added to the FusionAuth database.

`entityTypes[x].permissions[x].isDefault`Boolean

Whether or not the Permission is default. A default Permission is automatically assigned to an Entity if no permissions are provided.

`entityTypes[x].permissions[x].lastUpdateInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Permission was last updated in the FusionAuth database.

`entityTypes[x].permissions[x].name`String

The name of the Permission.

*Example Response JSON for all Entity Types*

```json
{
  "entityTypes": [
    {
      "entityType": {
        "data": {
          "createdBy": "jared@fusionauth.io"
        },
        "id": "8174f72f-5ecd-4eae-8de8-7fef597b3473",
        "insertInstant": 1595361142909,
        "jwtConfiguration": {
          "accessTokenKeyId": "a7516c7c-6234-4021-b0b4-8870c807aeb2",
          "enabled": true,
          "timeToLiveInSeconds": 3600
        },
        "lastUpdateInstant": 1595361143101,
        "name": "Customer",
        "permissions": [
          {
            "data": {
              "foo": "bar"
            },
            "id": "ce485a91-906f-4615-af75-81d37dc71e90",
            "insertInstant": 1595361142909,
            "isDefault": false,
            "lastUpdateInstant": 1595361143101,
            "name": "admin"
          },
          {
            "id": "ce485a91-906f-4615-af75-81d37dc71e91",
            "isDefault": true,
            "insertInstant": 1595361142911,
            "lastUpdateInstant": 1595361143111,
            "name": "user"
          }
        ]
      }
    }
  ]
}
```

## Update an Entity Type

This API is used to update an existing Entity Type.

You must specify all of the properties of the Entity Type when calling this API with the `PUT` HTTP method. When used with `PUT`, this API doesn't merge the existing Entity Type and your new data. It replaces the existing Entity Type with your new data.

Utilize the `PATCH` HTTP method to send specific changes to merge into an existing Entity Type.

### Request

[!Global API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#global-api-key-authentication)

Update an Entity Type by Id

PUT/api/entity/type/{entityTypeId}

OpenAPI Spec

PATCH/api/entity/type/{entityTypeId}

OpenAPI Spec

note

For backward compatibility, the `PATCH` method accepts the same media type (specified by a `Content-Type` of `application/json`) and body as the `PUT` request. You can also use the following media types for different behavior:

*   [JSON Patch/RFC 6902](https://www.rfc-editor.org/rfc/rfc6902): `application/json-patch+json`
*   [JSON Merge Patch/RFC 7396](https://www.rfc-editor.org/rfc/rfc7396): `merge-patch+json`

For details, see the [PATCH documentation](https://fusionauth.io/docs/apis.md#the-patch-http-method).

Using a media type of `application/json` merges the provided request parameters into the existing object. As a result, all parameters are optional with `PATCH`: only provide the values you want to change. To remove a value, provide a `null` value. Patching an `Array` appends all values in the new list to the old list.

#### Request Parameters

`entityTypeId`UUIDrequired

The Id of the Entity Type to update.

#### Request Body

`entityType.data`Objectoptional

An object that can hold any information about the Entity Type that should be persisted.

`entityType.jwtConfiguration.accessTokenKeyId`UUIDoptional

The unique id of the signing key used to sign the access token.

Required when **enabled** is set to `true`.

`entityType.jwtConfiguration.enabled`BooleanoptionalDefaults to false

Indicates if this application is using the JWT configuration defined here or the global JWT configuration defined by the Tenant. If this is `false` the signing algorithm configured in the Tenant will be used. If `true` the signing algorithm defined in this application will be used.

`entityType.jwtConfiguration.timeToLiveInSeconds`Integeroptional

The length of time in seconds the JWT will live before it is expired and no longer valid.

Required when **enabled** is set to `true`.

`entityType.name`Stringrequired

A descriptive name for the entity type (i.e. "Customer" or "Email\_Service").

*Example Request JSON*

```json
{
  "entityType": {
    "name": "Customer",
    "data": {
      "createdBy": "jared@fusionauth.io"
    },
    "jwtConfiguration": {
      "accessTokenKeyId": "a7516c7c-6234-4021-b0b4-8870c807aeb2",
      "enabled": true,
      "timeToLiveInSeconds": 3600
    }
  }
}
```

### Response

The response for this API contains the new information for the Entity Type that was updated.

*Response Codes*

| Code | Description |
| --- | --- |
| 200 | The request was successful. The response will contain a JSON body. |
| 400 | The request was invalid and/or malformed. The response will contain an [Errors](https://fusionauth.io/docs/apis/errors.md) JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See [Authentication](https://fusionauth.io/docs/apis/authentication.md). |
| 404 | The object you are trying to update doesn't exist. The response will be empty. |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
| 503 | The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body. |

#### Response Body

`entityType.data`Object

An object that can hold any information about the Entity Type that should be persisted.

`entityType.id`UUID

The Entity Type's unique Id.

`entityType.insertInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Entity Type was added to the FusionAuth database.

`entityType.jwtConfiguration.accessTokenKeyId`UUID

The unique id of the signing key used to sign the access token.

`entityType.jwtConfiguration.enabled`Boolean

Indicates if this application is using the JWT configuration defined here.

`entityType.jwtConfiguration.timeToLiveInSeconds`Integer

The length of time in seconds the JWT will live before it is expired and no longer valid.

`entityType.lastUpdateInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Entity Type was last updated in the FusionAuth database.

`entityType.name`Long

The name of the entity type (i.e. "Customer" or "Email\_Service").

`entityType.permissions`Array

An array of Permission objects.

`entityType.permissions[x].data`Object

An object that can hold any information about the Permission that should be persisted.

`entityType.permissions[x].description`String

A description of the Permission.

`entityType.permissions[x].id`UUID

The Id of the Permission.

`entityType.permissions[x].insertInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Permission was added to the FusionAuth database.

`entityType.permissions[x].isDefault`Boolean

Whether or not the Permission is default. A default Permission is automatically assigned to an Entity if no permissions are provided.

`entityType.permissions[x].lastUpdateInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Permission was last updated in the FusionAuth database.

`entityType.permissions[x].name`String

The name of the Permission.

*Example Response JSON for a Single Entity Type*

```json
{
  "entityType": {
    "data": {
      "createdBy": "jared@fusionauth.io"
    },
    "id": "8174f72f-5ecd-4eae-8de8-7fef597b3473",
    "insertInstant": 1595361142909,
    "jwtConfiguration": {
      "accessTokenKeyId": "a7516c7c-6234-4021-b0b4-8870c807aeb2",
      "enabled": true,
      "timeToLiveInSeconds": 3600
    },
    "lastUpdateInstant": 1595361143101,
    "name": "Customer",
    "permissions": [
      {
        "data": {
          "foo": "bar"
        },
        "id": "ce485a91-906f-4615-af75-81d37dc71e90",
        "insertInstant": 1595361142909,
        "isDefault": false,
        "lastUpdateInstant": 1595361143101,
        "name": "admin"
      },
      {
        "id": "ce485a91-906f-4615-af75-81d37dc71e91",
        "isDefault": true,
        "insertInstant": 1595361142911,
        "lastUpdateInstant": 1595361143111,
        "name": "user"
      }
    ]
  }
}
```

## Delete an Entity Type

This API is used to delete an Entity Type. You must specify the Id of the Entity Type on the URI.

### Request

[!Global API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#global-api-key-authentication)

Delete an Entity Type By Id

DELETE/api/entity/type/{entityTypeId}

OpenAPI Spec

#### Request Parameters

`entityTypeId`UUIDrequired

The Id of the Entity Type to delete.

### Response

This API does not return a JSON response body.

*Response Codes*

| Code | Description |
| --- | --- |
| 200 | The request was successful. |
| 400 | The request was invalid and/or malformed. The response will contain an [Errors](https://fusionauth.io/docs/apis/errors.md) JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See [Authentication](https://fusionauth.io/docs/apis/authentication.md). |
| 404 | The object you requested doesn't exist. The response will be empty. |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
| 503 | The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body. |

## Search for an Entity Type

This API is used to search for matching Entity Types.

### Request

[!Global API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#global-api-key-authentication)

Search Entity Types

GET/api/entity/type/search?name={name}

#### Request Parameters

`name`Stringrequired

The name of the Entity Type for which to search.

The search matches against the name field and any entity type matching. The match is case-insensitive, and you may not search by prefix or suffix. Whitespace is not allowed in the search. Regular expressions may not be used. A value of `*` will match all records.

`numberOfResults`IntegeroptionalDefaults to 25

The number of results to return from the search.

`orderBy`StringoptionalDefaults to name ASC

The database column to order the search results on plus the order direction.

The columns you can use for this are:

*   `insertInstant` - the [instant](https://fusionauth.io/docs/reference/data-types.md#instants) when the Entity Type was created
*   `lastUpdateInstant` - the [instant](https://fusionauth.io/docs/reference/data-types.md#instants) when the Entity Type was last updated
*   `name` - the name of the Entity Type

For example, to order the results by the insert instant in a descending order, the value would be provided as `insertInstant DESC`. The final string is optional can be set to `ASC` or `DESC`.

`startRow`IntegeroptionalDefaults to 0

The offset into the total results. In order to paginate the results, increment this value by the **numberOfResults** for subsequent requests.

### Response

The response for this API contains the Entity Type matching the search criteria in paginated format.

*Response Codes*

| Code | Description |
| --- | --- |
| 200 | The request was successful. The response will contain a JSON body. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See [Authentication](https://fusionauth.io/docs/apis/authentication.md). |
| 404 | The object you requested doesn't exist. The response will be empty. |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |

#### Response Body

`entityTypes[x]`Array

The list of EntityType objects.

`entityTypes[x].data`Object

An object that can hold any information about the Entity Type that should be persisted.

`entityTypes[x].id`UUID

The Entity Type's unique Id.

`entityTypes[x].insertInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Entity Type was added to the FusionAuth database.

`entityTypes[x].jwtConfiguration.accessTokenKeyId`UUID

The unique id of the signing key used to sign the access token.

`entityTypes[x].jwtConfiguration.enabled`Boolean

Indicates if this application is using the JWT configuration defined here.

`entityTypes[x].jwtConfiguration.timeToLiveInSeconds`Integer

The length of time in seconds the JWT will live before it is expired and no longer valid.

`entityTypes[x].lastUpdateInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Entity Type was last updated in the FusionAuth database.

`entityTypes[x].name`Long

The name of the entity type (i.e. "Customer" or "Email\_Service").

`entityTypes[x].permissions`Array

An array of Permission objects.

`entityTypes[x].permissions[x].data`Object

An object that can hold any information about the Permission that should be persisted.

`entityTypes[x].permissions[x].description`String

A description of the Permission.

`entityTypes[x].permissions[x].id`UUID

The Id of the Permission.

`entityTypes[x].permissions[x].insertInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Permission was added to the FusionAuth database.

`entityTypes[x].permissions[x].isDefault`Boolean

Whether or not the Permission is default. A default Permission is automatically assigned to an Entity if no permissions are provided.

`entityTypes[x].permissions[x].lastUpdateInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Permission was last updated in the FusionAuth database.

`entityTypes[x].permissions[x].name`String

The name of the Permission.

*Example Response JSON for all Entity Types*

```json
{
  "entityTypes": [
    {
      "entityType": {
        "data": {
          "createdBy": "jared@fusionauth.io"
        },
        "id": "8174f72f-5ecd-4eae-8de8-7fef597b3473",
        "insertInstant": 1595361142909,
        "jwtConfiguration": {
          "accessTokenKeyId": "a7516c7c-6234-4021-b0b4-8870c807aeb2",
          "enabled": true,
          "timeToLiveInSeconds": 3600
        },
        "lastUpdateInstant": 1595361143101,
        "name": "Customer",
        "permissions": [
          {
            "data": {
              "foo": "bar"
            },
            "id": "ce485a91-906f-4615-af75-81d37dc71e90",
            "insertInstant": 1595361142909,
            "isDefault": false,
            "lastUpdateInstant": 1595361143101,
            "name": "admin"
          },
          {
            "id": "ce485a91-906f-4615-af75-81d37dc71e91",
            "isDefault": true,
            "insertInstant": 1595361142911,
            "lastUpdateInstant": 1595361143111,
            "name": "user"
          }
        ]
      }
    }
  ]
}
```

## Create an Entity Type Permission

This API is used to create a permission for an Entity Type. Specifying an Id on the URI will instruct FusionAuth to use that Id when creating the permission. Otherwise, FusionAuth will generate an Id for the permission.

### Request

[!Global API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#global-api-key-authentication)

Create a Permission with a randomly generated Id

POST/api/entity/type/{entityTypeId}/permission

OpenAPI Spec

[!Global API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#global-api-key-authentication)

Create a Permission with a given Id

POST/api/entity/type/{entityTypeId}/permission/{permissionId}

OpenAPI Spec

#### Request Parameters

`entityTypeId`UUIDrequired

The Id of the Entity Type.

`permissionId`UUIDoptionalDefaults to secure random UUID

The Id to use for the new permission. If not specified a secure random UUID will be generated.

#### Request Body

`permission.data`Objectoptional

An object that can hold any information about the Permission that should be persisted.

`permission.description`Stringoptional

The description of the Permission.

`permission.isDefault`BooleanoptionalDefaults to false

Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.

`permission.name`Stringrequired

The name of the Permission. Once created, this field cannot be changed.

*Example Request JSON*

```json
{
  "permission": {
    "data": {
      "foo": "bar"
    },
    "description": "The permission description",
    "isDefault": true,
    "name": "read"
  }
}
```

### Response

The response for this API contains the information for the permission that was created.

*Response Codes*

| Code | Description |
| --- | --- |
| 200 | The request was successful. The response will contain a JSON body. |
| 400 | The request was invalid and/or malformed. The response will contain an [Errors](https://fusionauth.io/docs/apis/errors.md) JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See [Authentication](https://fusionauth.io/docs/apis/authentication.md). |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |

#### Response Body

`permission.data`Object

An object that can hold any information about the Permission that should be persisted.

`permission.description`String

The description of the Permission.

`permission.id`UUID

The Id of the Permission.

`permission.isDefault`Boolean

Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.

`permission.insertInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Permission was added to the FusionAuth database.

`permission.lastUpdateInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Permission was updated in the FusionAuth database.

`permission.name`String

The name of the Permission. Once created, this field cannot be changed.

*Example Response JSON*

```json
{
  "permission": {
    "data": {
      "foo": "bar"
    },
    "description": "The permission description",
    "id": "ce485a91-906f-4615-af75-81d37dc71e90",
    "insertInstant": 1595361142909,
    "isDefault": true,
    "lastUpdateInstant": 1595361143101,
    "name": "read"
  }
}
```

## Update an Entity Type Permission

This API is used to update an existing Entity Type permission. You must specify the Entity Type Id and the permission Id on the URI to identify the permission that is being updated.

### Request

[!Global API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#global-api-key-authentication)

Update an Entity Type Permission by Id

PUT/api/entity/type/{entityTypeId}/permission/{permissionId}

OpenAPI Spec

PATCH/api/entity/type/{entityTypeId}/permission/{permissionId}

OpenAPI Spec

note

For backward compatibility, the `PATCH` method accepts the same media type (specified by a `Content-Type` of `application/json`) and body as the `PUT` request. You can also use the following media types for different behavior:

*   [JSON Patch/RFC 6902](https://www.rfc-editor.org/rfc/rfc6902): `application/json-patch+json`
*   [JSON Merge Patch/RFC 7396](https://www.rfc-editor.org/rfc/rfc7396): `merge-patch+json`

For details, see the [PATCH documentation](https://fusionauth.io/docs/apis.md#the-patch-http-method).

Using a media type of `application/json` merges the provided request parameters into the existing object. As a result, all parameters are optional with `PATCH`: only provide the values you want to change. To remove a value, provide a `null` value. Patching an `Array` appends all values in the new list to the old list.

#### Request Parameters

`entityTypeId`UUIDrequired

The Id of the Entity Type.

`permissionId`UUIDrequired

The Id of the permission that is being updated.

#### Request Body

`permission.data`Objectoptional

An object that can hold any information about the Permission that should be persisted.

`permission.description`Stringoptional

The description of the Permission.

`permission.isDefault`BooleanoptionalDefaults to false

Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.

*Example Request JSON*

```json
{
  "permission": {
    "data": {
      "foo": "bar"
    },
    "description": "The permission description",
    "isDefault": true
  }
}
```

### Response

The response for this API contains the new information for the permission that was updated.

*Response Codes*

| Code | Description |
| --- | --- |
| 200 | The request was successful. The response will contain a JSON body. |
| 400 | The request was invalid and/or malformed. The response will contain an [Errors](https://fusionauth.io/docs/apis/errors.md) JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See [Authentication](https://fusionauth.io/docs/apis/authentication.md). |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |

#### Response Body

`permission.data`Object

An object that can hold any information about the Permission that should be persisted.

`permission.description`String

The description of the Permission.

`permission.id`UUID

The Id of the Permission.

`permission.isDefault`Boolean

Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.

`permission.insertInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Permission was added to the FusionAuth database.

`permission.lastUpdateInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Permission was updated in the FusionAuth database.

`permission.name`String

The name of the Permission. Once created, this field cannot be changed.

*Example Response JSON*

```json
{
  "permission": {
    "data": {
      "foo": "bar"
    },
    "description": "The permission description",
    "id": "ce485a91-906f-4615-af75-81d37dc71e90",
    "insertInstant": 1595361142909,
    "isDefault": true,
    "lastUpdateInstant": 1595361143101,
    "name": "read"
  }
}
```

## Delete an Entity Type Permission

This API is used to delete a permission from an Entity Type.

### Request

[!Global API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#global-api-key-authentication)

Delete an Entity Type Permission by Id

DELETE/api/entity/type/{entityTypeId}/permission/{permissionId}

OpenAPI Spec

#### Request Parameters

`entityTypeId`UUIDrequired

The Id of the Entity Type the permission belongs.

`permissionId`UUIDrequired

The Id of the permission to delete.

[!Global API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#global-api-key-authentication)

Delete an Entity Type Permission by name

DELETE/api/entity/type/{entityTypeId}/permission?name={name}

#### Request Parameters

`entityTypeId`UUIDrequired

The Id of the Entity Type the permission belongs.

`name`Stringrequired

The name of the permission to delete.

### Response

This API does not return a JSON response body.

*Response Codes*

| Code | Description |
| --- | --- |
| 200 | The request was successful. |
| 400 | The request was invalid and/or malformed. The response will contain an [Errors](https://fusionauth.io/docs/apis/errors.md) JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See [Authentication](https://fusionauth.io/docs/apis/authentication.md). |
| 404 | The object you requested doesn't exist. The response will be empty. |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |