IAM Roles Anywhere
Identity and Access Management Roles Anywhere provides a secure way for your workloads such as servers, containers, and applications that run outside of…
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
Identity and Access Management Roles Anywhere provides a secure way for your workloads such as servers, containers, and applications that run outside of Amazon Web Services to obtain temporary Amazon Web Services credentials. Your workloads can use the same IAM policies and roles you have for native Amazon Web Services applications to access Amazon Web Services resources. Using IAM Roles Anywhere eliminates the need to manage long-term credentials for workloads running outside of Amazon Web Services. To use IAM Roles Anywhere, your workloads must use X.509 certificates issued by their certificate authority (CA). You register the CA with IAM Roles Anywhere as a trust anchor to establish trust between your public key infrastructure (PKI) and IAM Roles Anywhere. If you don't manage your own PKI system, you can use Private Certificate Authority to create a CA and then use that to establish trust with IAM Roles Anywhere. This guide describes the IAM Roles Anywhere operations that you can call programmatically. For more information about IAM Roles Anywhere, see the IAM Roles Anywhere User Guide .
Endpoints 30
Profile
- GETList profiles
/profiles?nextToken=string&pageSize=0Lists all profiles in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListProfiles . - POSTCreate profile
/profilesCreates a profile , a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.… - PUTPut attribute mapping
/profiles/:profileId/mappingsPut an entry in the attribute mapping rules that will be enforced by a given profile. A mapping specifies a certificate field and one or more specifiers that… - DELETEDelete attribute mapping
/profiles/:profileId/mappings?certificateField=string&specifiers=Delete an entry from the attribute mapping rules enforced by a given profile. - GETGet profile
/profile/:profileIdGets a profile. Required permissions: rolesanywhere:GetProfile . - DELETEDelete profile
/profile/:profileIdDeletes a profile. Required permissions: rolesanywhere:DeleteProfile . - PATCHUpdate profile
/profile/:profileIdUpdates a profile , a list of the roles that IAM Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed… - POSTDisable profile
/profile/:profileId/disableDisables a profile. When disabled, temporary credential requests with this profile fail. Required permissions: rolesanywhere:DisableProfile . - POSTEnable profile
/profile/:profileId/enableEnables temporary credential requests for a profile. Required permissions: rolesanywhere:EnableProfile .
Trust anchor
- GETList trust anchors
/trustanchors?nextToken=string&pageSize=0Lists the trust anchors in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListTrustAnchors . - POSTCreate trust anchor
/trustanchorsCreates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA). You can define a trust anchor as a reference to an… - GETGet trust anchor
/trustanchor/:trustAnchorIdGets a trust anchor. Required permissions: rolesanywhere:GetTrustAnchor . - DELETEDelete trust anchor
/trustanchor/:trustAnchorIdDeletes a trust anchor. Required permissions: rolesanywhere:DeleteTrustAnchor . - PATCHUpdate trust anchor
/trustanchor/:trustAnchorIdUpdates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. You can define a… - POSTDisable trust anchor
/trustanchor/:trustAnchorId/disableDisables a trust anchor. When disabled, temporary credential requests specifying this trust anchor are unauthorized. Required permissions:… - POSTEnable trust anchor
/trustanchor/:trustAnchorId/enableEnables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation. Required permissions:…
Crl
- GETGet crl
/crl/:crlIdGets a certificate revocation list (CRL). Required permissions: rolesanywhere:GetCrl . - DELETEDelete crl
/crl/:crlIdDeletes a certificate revocation list (CRL). Required permissions: rolesanywhere:DeleteCrl . - PATCHUpdate crl
/crl/:crlIdUpdates the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate authority (CA). IAM Roles… - POSTDisable crl
/crl/:crlId/disableDisables a certificate revocation list (CRL). Required permissions: rolesanywhere:DisableCrl . - POSTEnable crl
/crl/:crlId/enableEnables a certificate revocation list (CRL). When enabled, certificates stored in the CRL are unauthorized to receive session credentials. Required… - GETList crls
/crls?nextToken=string&pageSize=0Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListCrls . - POSTImport crl
/crlsImports the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate Authority (CA).In order to be…
Subject
- GETGet subject
/subject/:subjectIdGets a subject , which associates a certificate identity with authentication attempts. The subject stores auditing information such as the status of the last… - GETList subjects
/subjects?nextToken=string&pageSize=0Lists the subjects in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListSubjects .
- GETList tags for resource
/ListTagsForResource?resourceArn=stringLists the tags attached to the resource. Required permissions: rolesanywhere:ListTagsForResource . - PATCHPut notification settings
/put-notifications-settingsAttaches a list of notification settings to a trust anchor. A notification setting includes information such as event name, threshold, status of the… - PATCHReset notification settings
/reset-notifications-settingsResets the custom notification setting to IAM Roles Anywhere default setting. Required permissions: rolesanywhere:ResetNotificationSettings . - POSTTag resource
/TagResourceAttaches tags to a resource. Required permissions: rolesanywhere:TagResource . - POSTUntag resource
/UntagResourceRemoves tags from the resource. Required permissions: rolesanywhere:UntagResource .
API details
- Base URL
https://rolesanywhere.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 30 operations on 20 pathsPOST 11GET 9PATCH 5DELETE 4PUT 1
- Main resources
- Profile 9Crl 7Trust anchor 7Subject 2
- Description format
- AWS Smithy model, API version
2018-05-10 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the IAM Roles Anywhere 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 IAM Roles Anywhere 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 “List profiles” (GET /profiles?nextToken=string&pageSize=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the IAM Roles Anywhere?
Identity and Access Management Roles Anywhere provides a secure way for your workloads such as servers, containers, and applications that run outside of… It is listed under Identity & security and has 30 endpoints.
Who publishes the IAM Roles Anywhere?
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 IAM Roles Anywhere?
Requests go to https://rolesanywhere.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the IAM Roles Anywhere?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the IAM Roles Anywhere have?
30 operations on 20 paths (11 POST, 9 GET, 5 PATCH, 4 DELETE, 1 PUT). The largest groups are Profile, Crl, Trust anchor, Subject.
Is forking the IAM Roles Anywhere free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.