# List entities with specified project permissions - ListEntitiesForProject

## Overview

List entities with specified project permissions






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListEntitiesForProject`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.scloudsg.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ProjectID** | string | Project ID |**Yes**|
| **Limit** | string | The number of user groups to be queried |No|
| **Offset** | string | Start querying from which data entry |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **Entities** | array[[*Entity*](#entity)] | Entity authorized for project permissions |**Yes**|
| **TotalCount** | int | Number of Data Sets |**Yes**|

#### Data Model


#### Entity

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **EntityName** | string | Entity Name. |**Yes**|
| **EntityKind** | string | Entity Type (User: User, Group) |**Yes**|
| **AttachedAt** | int | Quotation Time |**Yes**|
| **DisplayName** | string | Sub-account Display Name |**Yes**|
| **Scope** | string | Effective Space |No|

## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=ListEntitiesForProject
&ProjectID=LjAdemcs
&Limit=lmjPWkdl
&Offset=NMyWAVrU
```

### Response Example
    
```json
{
  "Action": "ListEntitiesForProjectResponse",
  "Entities": "dRCPbpgQ",
  "Message": "gNDOHVFF",
  "RetCode": 0,
  "TotalCount": "cJxZCbIZ"
}
```