---
title: "Deployment Receiver"
description: "Explore the comprehensive guide to Deployment Receiver: methods, properties, and setup to boost your platform integration. (Gitana 4.0)"
product: "Gitana"
version: "4.0"
url: "/documentation/gitana/4.0/reference/types/deployment-receiver"
---

# <a id="top"></a>Deployment Receiver

An Object

1.  [Platform](/documentation/gitana/4.0/reference/types/platform.md)
2.  [Deployment Receiver](/documentation/gitana/4.0/reference/types/deployment-receiver.md)

##### Table of Contents

- [Overview](#top "Overview")
- [Parent](#parent "Parent")
- [Properties](#properties "Properties")
- [Methods](#methods "Methods")
- [Schema](#schema "Schema")

> **Note:** Drop in one of our language drivers to accelerate your development.  
> Here are links to some of our popular [Cookbooks](/documentation/gitana/4.0/developers/cookbooks/overview.md) to help you get started!
> 
> - [C#](/documentation/gitana/4.0/developers/cookbooks/csharp.md)
> - [Go](/documentation/gitana/4.0/developers/cookbooks/go.md)
> - [Java](/documentation/gitana/4.0/developers/cookbooks/java.md)
> - [JavaScript](/documentation/gitana/4.0/developers/cookbooks/javascript2.md)
> - [PHP](/documentation/gitana/4.0/developers/cookbooks/php.md)
> - [Python](/documentation/gitana/4.0/developers/cookbooks/python.md)
> - [Ruby](/documentation/gitana/4.0/developers/cookbooks/ruby.md)

## <a id="parent"></a>Parent

This Deployment Receiver is contained within a [Platform](/documentation/gitana/4.0/reference/types/platform.md).

## <a id="properties"></a>Properties

The following properties are available:

| Property | Type | Default | Read-Only | Description |
| --- | --- | --- | --- | --- |
| \_doc | string |  | No | The primary ID |
| \_system | object |  | No | Metadata maintained by the system |

## <a id="methods"></a>Methods

The following methods are available:

- [Check Permission](#post-deployment-strategies-deploymentreceiverid-permissions-permissionid-check "Check Permission")
- [Check Single Authority](#post-deployment-receivers-deploymentreceiverid-authorities-authorityid-check "Check Single Authority")
- [Check multiple Authorities](#post-deployment-receivers-authorities-check "Check multiple Authorities")
- [Check multiple Permissions](#post-deployment-receivers-permissions-check "Check multiple Permissions")
- [Create Deployment Receiver](#post-deployment-receivers "Create Deployment Receiver")
- [Delete Deployment Receiver](#post-deployment-receivers-deploymentreceiverid-delete "Delete Deployment Receiver")
- [Delete Deployment Receiver](#delete-deployment-receivers-deploymentreceiverid "Delete Deployment Receiver")
- [Grant Authority](#post-deployment-receivers-deploymentreceiverid-authorities-authorityid-grant "Grant Authority")
- [Lists Deployment Receiver](#get-deployment-receivers "Lists Deployment Receiver")
- [Push Receiver](#post-deployment-receivers-deploymentreceiverid-push "Push Receiver")
- [Queries for Deployment Receiver](#post-deployment-receivers-query "Queries for Deployment Receiver")
- [Read ACL](#get-deployment-receivers-deploymentreceiverid-acl-list "Read ACL")
- [Read ACL for Principal](#get-deployment-receivers-deploymentreceiverid-acl "Read ACL for Principal")
- [Read Authorities Report](#post-deployment-receivers-deploymentreceiverid-authorities "Read Authorities Report")
- [Read Deployment Receiver](#get-deployment-receivers-deploymentreceiverid "Read Deployment Receiver")
- [Revoke Authority](#post-deployment-receivers-deploymentreceiverid-authorities-authorityid-revoke "Revoke Authority")
- [Update Deployment Receiver](#put-deployment-receivers-deploymentreceiverid "Update Deployment Receiver")
- [Update Deployment Receiver](#post-deployment-receivers-deploymentreceiverid-update "Update Deployment Receiver")

### <a id="post-deployment-strategies-deploymentreceiverid-permissions-permissionid-check"></a>Check Permission

Checks whether one or more authorities against the specified deployment-receiver are granted for a given set of users

POST /deployment/strategies/{deploymentReceiverId}/permissions/{permissionId}/check

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| deploymentReceiverId | true | string |  |
| permissionId | true | string | The ID of the permission |
| id | true | string |  |

#### Response

```json
{
  "$ref": "#/components/schemas/checkPermission"
}
```

### <a id="post-deployment-receivers-deploymentreceiverid-authorities-authorityid-check"></a>Check Single Authority

Checks whether a single authority is granted against the specified deployment-receiver for the given user

POST /deployment/receivers/{deploymentReceiverId}/authorities/{authorityId}/check

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| deploymentReceiverId | true | string |  |
| authorityId | true | string | The ID or authority key for the authority |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}
```

### <a id="post-deployment-receivers-authorities-check"></a>Check multiple Authorities

Checks whether one or more authorities against the specified deployment-receiver are granted for a given set of users

POST /deployment/receivers/authorities/check

#### Parameters

This function has no parameters.

#### Response

```json
{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}
```

### <a id="post-deployment-receivers-permissions-check"></a>Check multiple Permissions

Checks whether one or more permissions against the specified deployment-receiver are granted for a given set of users

POST /deployment/receivers/permissions/check

#### Parameters

This function has no parameters.

#### Response

```json
{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}
```

### <a id="post-deployment-receivers"></a>Create Deployment Receiver

Creates a new Deployment Receiver

POST /deployment/receivers

#### Parameters

This function has no parameters.

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-deployment-receivers-deploymentreceiverid-delete"></a>Delete Deployment Receiver

Deletes an existing Deployment Receiver

POST /deployment/receivers/{deploymentReceiverId}/delete

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| deploymentReceiverId | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="delete-deployment-receivers-deploymentreceiverid"></a>Delete Deployment Receiver

Deletes an existing Deployment Receiver

DELETE /deployment/receivers/{deploymentReceiverId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| deploymentReceiverId | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-deployment-receivers-deploymentreceiverid-authorities-authorityid-grant"></a>Grant Authority

Grants an authority against the specified deployment-receiver to a given user

POST /deployment/receivers/{deploymentReceiverId}/authorities/{authorityId}/grant

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| deploymentReceiverId | true | string |  |
| authorityId | true | string | The ID or authority key for the authority |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="get-deployment-receivers"></a>Lists Deployment Receiver

Retrieves a list of Deployment Receiver instances

GET /deployment/receivers

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| sort | false | object | Defines how to sort fields in the result set |
| skip | false | number | Skips the result set cursor ahead the specified number of records |
| limit | false | number | Specifies the number of records to be handed back in the result set |

This method supports pagination.

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_deployment-receiver"
      }
    }
  }
}
```

### <a id="post-deployment-receivers-deploymentreceiverid-push"></a>Push Receiver

POST /deployment/receivers/{deploymentReceiverId}/push

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| deploymentReceiverId | true | string |  |
| operation | true | string |  |

### <a id="post-deployment-receivers-query"></a>Queries for Deployment Receiver

Queries for instances of type Deployment Receiver

POST /deployment/receivers/query

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| sort | false | object | Defines how to sort fields in the result set |
| skip | false | number | Skips the result set cursor ahead the specified number of records |
| limit | false | number | Specifies the number of records to be handed back in the result set |

This method supports pagination.

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_deployment-receiver"
      }
    }
  }
}
```

### <a id="get-deployment-receivers-deploymentreceiverid-acl-list"></a>Read ACL

Read the Access Control List for the specified deployment-receiver

GET /deployment/receivers/{deploymentReceiverId}/acl/list

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| deploymentReceiverId | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}
```

### <a id="get-deployment-receivers-deploymentreceiverid-acl"></a>Read ACL for Principal

Reads the ACL for a deployment strategy and specific actor

GET /deployment/receivers/{deploymentReceiverId}/acl

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| deploymentReceiverId | true | string |  |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}
```

### <a id="post-deployment-receivers-deploymentreceiverid-authorities"></a>Read Authorities Report

Read the Authorities Report for the specified deployment-receiver

POST /deployment/receivers/{deploymentReceiverId}/authorities

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| deploymentReceiverId | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
```

### <a id="get-deployment-receivers-deploymentreceiverid"></a>Read Deployment Receiver

Reads an instance of a Deployment Receiver

GET /deployment/receivers/{deploymentReceiverId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| deploymentReceiverId | true | string |  |

#### Response

```json
{
  "type": "object",
  "extends": "document",
  "description": "Deployment Receiver",
  "container": "platform",
  "properties": {
    "_doc": null,
    "_system": null
  }
}
```

### <a id="post-deployment-receivers-deploymentreceiverid-authorities-authorityid-revoke"></a>Revoke Authority

Revokes an authority against the specified deployment-receiver from a given user

POST /deployment/receivers/{deploymentReceiverId}/authorities/{authorityId}/revoke

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| deploymentReceiverId | true | string |  |
| authorityId | true | string | The ID or authority key for the authority |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="put-deployment-receivers-deploymentreceiverid"></a>Update Deployment Receiver

Updates an existing Deployment Receiver

PUT /deployment/receivers/{deploymentReceiverId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| deploymentReceiverId | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-deployment-receivers-deploymentreceiverid-update"></a>Update Deployment Receiver

Updates an existing Deployment Receiver

POST /deployment/receivers/{deploymentReceiverId}/update

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| deploymentReceiverId | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

## <a id="schema"></a>Schema

```json

{
  "type": "object",
  "extends": "document",
  "description": "Deployment Receiver",
  "container": "platform",
  "properties": {
    "_doc": null,
    "_system": null
  },
  "id": "deployment-receiver"
}
```