Binary Authorization API
The management interface for Binary Authorization, a service that provides policy-based deployment validation and control for images deployed to Google…
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
The management interface for Binary Authorization, a service that provides policy-based deployment validation and control for images deployed to Google Kubernetes Engine (GKE), Anthos Service Mesh, Anthos Clusters, and Cloud Run.
Endpoints 12
systempolicy
- GETGets the current system policy in the specified location.
/v1/:nameGets the current system policy in the specified location.
projects.platforms.policies
- PUTReplaces a platform policy
/v1/:nameReplaces a platform policy. Returns NOT_FOUND if the policy doesn't exist. - DELETEDeletes a platform policy
/v1/:name?etag=stringDeletes a platform policy. Returns NOT_FOUND if the policy doesn't exist. - GETLists platform policies owned by a project in the specified platform
/v1/:parent/policies?pageSize=0&pageToken=stringLists platform policies owned by a project in the specified platform. Returns INVALID_ARGUMENT if the project or the platform doesn't exist. - POSTCreates a platform policy, and returns a copy of it
/v1/:parent/policies?policyId=stringCreates a platform policy, and returns a copy of it. Returns NOT_FOUND if the project or platform doesn't exist, INVALID_ARGUMENT if the request is malformed,…
projects.attestors
- GETLists attestors
/v1/:parent/attestors?pageSize=0&pageToken=stringLists attestors. Returns INVALID_ARGUMENT if the project does not exist. - POSTCreates an attestor, and returns a copy of the new attestor
/v1/:parent/attestors?attestorId=stringCreates an attestor, and returns a copy of the new attestor. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed,… - POSTReturns whether the given `Attestation` for the given image URI was signed by the given `Attestor`
/v1/:attestor:validateAttestationOccurrenceReturns whether the given Attestation for the given image URI was signed by the given Attestor
projects.policy
- GETGets the access control policy for a resource
/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - POSTSets the access control policy on the specified resource
/v1/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - POSTReturns permissions that a caller has on the specified resource
/v1/:resource:testIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND…
projects.platforms.gke.policies
- POSTEvaluates a Kubernetes object versus a GKE platform policy
/v1/:name:evaluateEvaluates a Kubernetes object versus a GKE platform policy. Returns NOT_FOUND if the policy doesn't exist, INVALID_ARGUMENT if the policy or request is…
API details
- Base URL
https://binaryauthorization.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 12 operations on 8 pathsPOST 6GET 4PUT 1DELETE 1
- Main resources
- projects.platforms.policies 4projects.attestors 3projects.policy 3projects.platforms.gke.policies 1systempolicy 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 Binary Authorization 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 Binary Authorization 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 “Gets the current system policy in the specified location.” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Binary Authorization API?
The management interface for Binary Authorization, a service that provides policy-based deployment validation and control for images deployed to Google… It is listed under Identity & security and has 12 endpoints.
Who publishes the Binary Authorization 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 Binary Authorization API?
Requests go to https://binaryauthorization.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Binary Authorization 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 Binary Authorization API have?
12 operations on 8 paths (6 POST, 4 GET, 1 PUT, 1 DELETE). The largest groups are projects.platforms.policies, projects.attestors, projects.policy, projects.platforms.gke.policies.
Is forking the Binary Authorization API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.