Access Context Manager API
An API for setting attribute based access control to requests to Google Cloud services. *Warning:* Do not mix *v1alpha* and *v1* API usage in the same access…
Identity & security#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
An API for setting attribute based access control to requests to Google Cloud services. Warning: Do not mix v1alpha and v1 API usage in the same access policy. The v1alpha API supports new Access Context Manager features, which may have different attributes or behaviors that are not supported by v1. The practice of mixed API usage within a policy may result in the inability to update that policy, including any access levels or service perimeters belonging to it. It is not recommended to use both v1 and v1alpha for modifying policies with critical service perimeters. Modifications using v1alpha should be limited to policies with non-production/non-critical service perimeters.
Endpoints 24
accessPolicies
- GETLists all access policies in an organization.
/v1/accessPolicies?pageSize=0&pageToken=string&parent=stringLists all access policies in an organization. - POSTCreates an access policy
/v1/accessPoliciesCreates an access policy. This method fails if the organization already has an access policy. The long-running operation has a successful status after the… - POSTGets the IAM policy for the specified Access Context Manager access policy.
/v1/:resource:getIamPolicyGets the IAM policy for the specified Access Context Manager access policy. - POSTSets the IAM policy for the specified Access Context Manager access policy
/v1/:resource:setIamPolicySets the IAM policy for the specified Access Context Manager access policy. This method replaces the existing IAM policy on the access policy. The IAM policy…
organizations.gcpUserAccessBindings
- GETGets the GcpUserAccessBinding with the given name.
/v1/:nameGets the GcpUserAccessBinding with the given name. - DELETEDeletes a GcpUserAccessBinding
/v1/:nameDeletes a GcpUserAccessBinding. Completion of this long-running operation does not necessarily signify that the binding deletion is deployed onto all affected… - PATCHUpdates a GcpUserAccessBinding
/v1/:name?append=true&updateMask=stringUpdates a GcpUserAccessBinding. Completion of this long-running operation does not necessarily signify that the changed binding is deployed onto all affected… - GETLists all GcpUserAccessBindings for a Google Cloud organization.
/v1/:parent/gcpUserAccessBindings?filter=string&pageSize=0&pageToken=stringLists all GcpUserAccessBindings for a Google Cloud organization. - POSTCreates a GcpUserAccessBinding
/v1/:parent/gcpUserAccessBindingsCreates a GcpUserAccessBinding. If the client specifies a name, the server ignores it. Fails if a resource already exists with the same group_key. Completion…
accessPolicies.servicePerimeters
- POSTReturns the IAM permissions that the caller has on the specified Access Context Manager resource
/v1/:resource:testIamPermissionsReturns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or… - POSTCommits the dry-run specification for all the service perimeters in an access policy
/v1/:parent/servicePerimeters:commitCommits the dry-run specification for all the service perimeters in an access policy. A commit operation on a service perimeter involves copying its spec… - GETLists all service perimeters for an access policy.
/v1/:parent/servicePerimeters?deletedPrincipalSyntax=DELETED_PRINCIPAL_SYNTAX_SUPPORT_UNSPECIFIED&pageSize=0&pageToken=stringLists all service perimeters for an access policy. - POSTCreates a service perimeter
/v1/:parent/servicePerimetersCreates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage.… - POSTReplaces all existing service perimeters in an access policy with the service perimeters provided
/v1/:parent/servicePerimeters:replaceAllReplaces all existing service perimeters in an access policy with the service perimeters provided. This is done atomically. The long-running operation from…
accessPolicies.accessLevels
- GETLists all access levels for an access policy.
/v1/:parent/accessLevels?accessLevelFormat=LEVEL_FORMAT_UNSPECIFIED&pageSize=0&pageToken=stringLists all access levels for an access policy. - POSTCreates an access level
/v1/:parent/accessLevelsCreates an access level. The long-running operation from this RPC has a successful status after the access level propagates to long-lasting storage. If access… - POSTReplaces all existing access levels in an access policy with the access levels provided
/v1/:parent/accessLevels:replaceAllReplaces all existing access levels in an access policy with the access levels provided. This is done atomically. The long-running operation from this RPC has…
accessPolicies.authorizedOrgsDescs
- GETLists all authorized orgs descs for an access policy.
/v1/:parent/authorizedOrgsDescs?pageSize=0&pageToken=stringLists all authorized orgs descs for an access policy. - POSTCreates an authorized orgs desc
/v1/:parent/authorizedOrgsDescsCreates an authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting…
projects
- GETLooks up the configured ServicePerimeter for a given resource.
/v1/:resource:lookupConfiguredServicePerimeterLooks up the configured ServicePerimeter for a given resource.
operations
- POSTStarts asynchronous cancellation on a long-running operation
/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…
permissions
- GETLists all supported permissions in VPC Service Controls ingress and egress rules for Granular Controls.
/v1/permissions?pageSize=0&pageToken=stringLists all supported permissions in VPC Service Controls ingress and egress rules for Granular Controls.
services
- GETReturns a VPC-SC supported service based on the service name
/v1/services/:nameReturns a VPC-SC supported service based on the service name. IAM Permissions: Requires the following IAM permissions to use this method: -… - GETLists all VPC-SC supported services
/v1/services?pageSize=0&pageToken=stringLists all VPC-SC supported services. IAM Permissions: Requires the following IAM permissions to use this method: - serviceusage.services.use on the project.
API details
- Base URL
https://accesscontextmanager.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 24 operations on 17 pathsPOST 12GET 10PATCH 1DELETE 1
- Main resources
- accessPolicies.servicePerimeters 5organizations.gcpUserAccessBindings 5accessPolicies 4accessPolicies.accessLevels 3accessPolicies.authorizedOrgsDescs 2services 2operations 1permissions 1projects 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Access Context Manager API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Access Context Manager API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Lists all access policies in an organization.” (GET /v1/accessPolicies?pageSize=0&pageToken=string&parent=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Access Context Manager API?
An API for setting attribute based access control to requests to Google Cloud services. *Warning:* Do not mix *v1alpha* and *v1* API usage in the same access… It is listed under Identity & security and has 24 endpoints.
Who publishes the Access Context Manager API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Access Context Manager API?
Requests go to https://accesscontextmanager.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Access Context Manager API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the Access Context Manager API have?
24 operations on 17 paths (12 POST, 10 GET, 1 PATCH, 1 DELETE). The largest groups are accessPolicies.servicePerimeters, organizations.gcpUserAccessBindings, accessPolicies, accessPolicies.accessLevels.
Is forking the Access Context Manager API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.