Access Groups
Inspect access groups in your team to understand which members and projects belong to each group. You can also retrieve details for a specific group or its project access.
List members of an access group.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | The ID or name of the Access Group. |
limit | integer | No | Limit how many access group members should be returned. Minimum: 1. Maximum: 100. |
next | string | No | Continuation cursor to retrieve the next page of results. |
search | string | No | Search access group members by their name, username, and email. |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
List projects of an access group.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | The ID or name of the Access Group. |
limit | integer | No | Limit how many access group projects should be returned. Minimum: 1. Maximum: 100. |
next | string | No | Continuation cursor to retrieve the next page of results. |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
List access groups
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | No | Filter access groups by project. |
search | string | No | Search for access groups by name. |
membersLimit | integer | No | Number of members to include in the response. Minimum: 1. Maximum: 100. |
projectsLimit | integer | No | Number of projects to include in the response. Minimum: 1. Maximum: 100. |
limit | integer | No | Limit how many access groups to return. Minimum: 1. Maximum: 100. |
next | string | No | Continuation cursor to retrieve the next page of results. |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
Reads an access group.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | The access group ID or name. |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
Reads an access group project.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
accessGroupIdOrName | string | Yes | The access group ID or name. |
projectId | string | Yes | The project ID. |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
Was this helpful?