AWS Multi-party Approval
Multi-party approval is a capability of Organizations that allows you to protect a predefined list of operations through a distributed approval process. Use…
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
Multi-party approval is a capability of Organizations that allows you to protect a predefined list of operations through a distributed approval process. Use Multi-party approval to establish approval workflows and transform security processes into team-based decisions. When to use Multi-party approval : You need to align with the Zero Trust principle of "never trust, always verify" You need to make sure that the right humans have access to the right things in the right way You need distributed decision-making for sensitive or critical operations You need to protect against unintended operations on sensitive or critical resources You need formal reviews and approvals for auditing or compliance reasons For more information, see What is Multi-party approval in the Multi-party approval User Guide .
Endpoints 22
Session
- GETGet session
/sessions/:SessionArnReturns details for an approval session. For more information, see Session in the Multi-party approval User Guide . - PUTCancel session
/sessions/:SessionArnCancels an approval session. For more information, see Session in the Multi-party approval User Guide . - POSTList sessions
/approval-teams/:ApprovalTeamArn/sessions/?List=Returns a list of approval sessions. For more information, see Session in the Multi-party approval User Guide .
Approval team
- POSTCreate approval team
/approval-teamsCreates a new approval team. For more information, see Approval team in the Multi-party approval User Guide . - DELETEDelete inactive approval team version
/approval-teams/:Arn/:VersionIdDeletes an inactive approval team. For more information, see Team health in the Multi-party approval User Guide . You can also use this operation to delete a… - GETGet approval team
/approval-teams/:ArnReturns details for an approval team. - POSTStart active approval team deletion
/approval-teams/:Arn?Delete=Starts the deletion process for an active approval team. Deletions require team approval Requests to delete an active team must be approved by the team. - PATCHUpdate approval team
/approval-teams/:ArnUpdates an approval team. You can request to update the team description, approval threshold, and approvers in the team. Updates require team approval Updates… - POSTList approval teams
/approval-teams/?List=&MaxResults=0&NextToken=stringReturns a list of approval teams. - POSTStart approval team baseline
/approval-teams/:Arn/baselineStarts a baseline session for specified approvers on an ACTIVE approval team.
Identity source
- POSTCreate identity source
/identity-sourcesCreates a new identity source. For more information, see Identity Source in the Multi-party approval User Guide . - GETGet identity source
/identity-sources/:IdentitySourceArnReturns details for an identity source. For more information, see Identity Source in the Multi-party approval User Guide . - DELETEDelete identity source
/identity-sources/:IdentitySourceArnDeletes an identity source. For more information, see Identity Source in the Multi-party approval User Guide . - POSTList identity sources
/identity-sources/?List=&MaxResults=0&NextToken=stringReturns a list of identity sources. For more information, see Identity Source in the Multi-party approval User Guide .
- GETGet policy version
/policy-versions/:PolicyVersionArnReturns details for the version of a policy. Policies define the permissions for team resources. - POSTGet resource policy
/GetResourcePolicyReturns details about a policy for a resource. - POSTList policies
/policies/?List=&MaxResults=0&NextToken=stringReturns a list of policies. Policies define the permissions for team resources. - POSTList policy versions
/policies/:PolicyArn/?List=&MaxResults=0&NextToken=stringReturns a list of the versions for policies. Policies define the permissions for team resources. - POSTList resource policies
/resource-policies/:ResourceArn/?List=&MaxResults=0&NextToken=stringReturns a list of policies for a resource. - GETList tags for resource
/tags/:ResourceArnReturns a list of the tags for a resource. - PUTTag resource
/tags/:ResourceArnCreates or updates a resource tag. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for,… - POSTUntag resource
/tags/:ResourceArnRemoves a resource tag. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter…
API details
- Base URL
https://mpa.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 22 operations on 16 pathsPOST 12GET 5PUT 2DELETE 2PATCH 1
- Main resources
- Approval team 7Identity source 4Session 3
- Description format
- AWS Smithy model, API version
2022-07-26 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Multi-party Approval 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 AWS Multi-party Approval collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get session” (GET /sessions/:SessionArn), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Multi-party Approval?
Multi-party approval is a capability of Organizations that allows you to protect a predefined list of operations through a distributed approval process. Use… It is listed under Developer tools and has 22 endpoints.
Who publishes the AWS Multi-party Approval?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Multi-party Approval?
Requests go to https://mpa.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Multi-party Approval?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Multi-party Approval have?
22 operations on 16 paths (12 POST, 5 GET, 2 PUT, 2 DELETE, 1 PATCH). The largest groups are Approval team, Identity source, Session.
Is forking the AWS Multi-party Approval free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.