2024-09-11
▼ ▲ apigee.organizations.environments.deployments.testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:testIamPermissions
Flat Path: v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:testIamPermissions
Parameter Order: resource
Parameters:
resource
Required: Yes
Pattern: ^organizations/[^/]+/environments/[^/]+/deployments/[^/]+$
Type: string
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Description: Tests the permissions of a user on a deployment, and returns a subset of permissions that the user has on the deployment. If the deployment does not exist, an empty permission set is returned (a NOT_FOUND error is not returned).
HTTP Method: POST
▼ ▲ apigee.organizations.environments.deployments.setIamPolicy
Path: v1/{+resource}:setIamPolicy
Description: Sets the IAM policy on a deployment, if the policy already exists it will be replaced. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.deployments.setIamPolicy` permission to call this API.
HTTP Method: POST
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Pattern: ^organizations/[^/]+/environments/[^/]+/deployments/[^/]+$
Type: string
Location: path
Parameter Order: resource
Flat Path: v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:setIamPolicy
▼ ▲ apigee.organizations.environments.deployments.get
Flat Path: v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Description: Required. Name of the api proxy or the shared flow deployment. Use the following structure in your request: `organizations/{org}/environments/{env}/deployments/{deployment}`
Pattern: ^organizations/[^/]+/environments/[^/]+/deployments/[^/]+$
Required: Yes
Type: string
Description: Gets a particular deployment of Api proxy or a shared flow in an environment
Path: v1/{+name}
HTTP Method: GET
Parameter Order: name
▼ ▲ apigee.organizations.environments.deployments.getIamPolicy
Path: v1/{+resource}:getIamPolicy
HTTP Method: GET
Parameters:
options.requestedPolicyVersion
Format: int32
Type: integer
Location: query
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
resource
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Type: string
Required: Yes
Pattern: ^organizations/[^/]+/environments/[^/]+/deployments/[^/]+$
Parameter Order: resource
Flat Path: v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the IAM policy on a deployment. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.deployments.getIamPolicy` permission to call this API.