REST API v2.0 Reference
- Steffen Opel [Utoolity]
- Jana Lehmann [Utoolity]
This is the Identity Federation for AWS REST API v2.0 reference (refer to the Developer Guide for more information).
On this page:
- 1 REST API v2.0 resources (Identity Federation)
- 1.1 /rest/identity-federation-for-aws/2.0/connectors
- 1.2 /rest/identity-federation-for-aws/2.0/connectors/{id}
- 1.3 /rest/identity-federation-for-aws/2.0/connectors/{id}/caller-identity
- 1.4 /rest/identity-federation-for-aws/2.0/connectors/{id}/credentials
- 1.5 /rest/identity-federation-for-aws/2.0/connectors/{id}/console/url
- 1.6 /rest/identity-federation-for-aws/2.0/connectors/{id}/ecr/credentials?region={region}
- 2 REST API v2.0 resources (complete reference)
- 3 Frequently Asked Questions (FAQ)
REST API v2.0 resources (Identity Federation)
This is the reference of all resources relevant to this apps actual functionality as a token vendor for Identity Federation - refer to the REST API resources (complete reference) if you intent to include this app into administrative automation scenarios (e.g. for scripting).
Resource | URI template | methods | description | permissions | comments |
|---|---|---|---|---|---|
Connectors | This is the main resource to interact with currently in order to retrieve temporary AWS security credentials. | ||||
GET | Get all AWS connectors. | Configurable | |||
GET | Get an AWS connector identified by its id. | Configurable | |||
GET | Get details about the IAM identity whose credentials are used to call the API. | Configurable | |||
GET | Get temporary AWS security credentials via a AWS connector identified by its id. | Configurable | This is the main resource to use for calling AWS services in turn. | ||
GET | Get the URL for SSO with the AWS Management Console via a AWS connector identified by its id. | Configurable | The returned URL is not the final one, rather the one to present to users so that following it will yield the SSO with AWS in turn (provided the executing user has permission to use the connector). | ||
GET | Get temporary Amazon ECR authentication credentials via a AWS connector identified by its id. | Configurable | Refer to Amazon EC2 Container Registry (Amazon ECR) authentication credentials for details.
|
/rest/identity-federation-for-aws/2.0/connectorsMethodsGETRequestGET http://host:port/context/rest/identity-federation-for-aws/2.0/connectors (200)
Server: Apache-Coyote/1.1
X-AREQUESTID: 1384x1779x1
X-ASESSIONID: 1dteqyw
X-Seraph-LoginReason: OK
X-AUSERNAME: admin
Cache-Control: no-cache, no-store, no-transform
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Tue, 04 Jun 2013 21:04:32 GMT
{
"values": [
{
"id": "1521fbf0-fa97-4c4a-9877-9f0c5e9982d3",
"name": "Development Team A",
"type": "FEDERATION_TOKEN",
"partition": "aws"
},
{
"id": "1f2d5aee-839e-49ae-8a5b-e9ae27a2f2d8",
"name": "Development Team B",
"type": "SESSION_TOKEN",
"partition": "aws"
},
{
"id": "997a2479-a27c-46fc-9397-9a6bff91b7dd",
"name": "Operations Team",
"type": "FEDERATION_TOKEN"
"scope": "SYSTEM",
"partition": "aws"
}
],
"size": 3
} |
/rest/identity-federation-for-aws/2.0/connectors/{id}MethodsGETRequest
|
/rest/identity-federation-for-aws/2.0/connectors/{id}/caller-identityMethodsGETRequest
|
/rest/identity-federation-for-aws/2.0/connectors/{id}/credentialsMethodsGETRequest
|
/rest/identity-federation-for-aws/2.0/connectors/{id}/console/urlMethodsGETRequest
|
/rest/identity-federation-for-aws/2.0/connectors/{id}/ecr/credentials?region={region}MethodsGETRequest
|
REST API v2.0 resources (complete reference)
This is the complete reference of all resources available. You usually won't interact with most of these outside of administrative automation scenarios (e.g. for scripting) - please see the REST API resources (Identity Federation) for this apps actual functionality first.
Resource | URI template | methods | status | description | permissions | comments |
|---|---|---|---|---|---|---|
Accounts | internal You usually won't interact with accounts (access keys) via the API currently, please see the Connectors resource instead! | |||||
/accounts | GET|POST | internal | Get all accounts (IAM users). | Administrator | ||
/accounts/{id} | GET|DELETE|PUT | internal | Get an account (IAM user) identified by its id. | Administrator | ||
Connectors | This is the main resource to interact with currently in order to retrieve temporary AWS security credentials. | |||||
/connectors | GET | PUBLIC | Get all AWS connectors. | Configurable | You only need GET for the intended usage as a token vendor, but POST will be added in a subsequent release regardless. | |
/connectors/{id} | GET | PUBLIC | Get an AWS connector identified by its id. | Configurable | You only need GET for the intended usage as a token vendor, but DELETE|PUT will be added in a subsequent release regardless. | |
/connectors/{id}/caller-identity | GET | PUBLIC | Get details about the IAM identity whose credentials are used to call the API. | Configurable | ||
/connectors/{id}/credentials | GET | PUBLIC | Get the temporary AWS security credentials via an AWS connector identified by its id. | Configurable | This is the main resource to use for calling AWS services in turn. | |
/connectors/{id}/console/url | GET | PUBLIC | Get the URL for SSO with the AWS Management Console via a AWS connector identified by its id. | Configurable | The returned URL is not the final one, rather the one to present to users so that following it will yield the SSO with AWS in turn (provided the executing user has permission to use the connector). | |
/connectors/{id}/ecr/credentials | GET | PUBLIC | Get temporary Amazon ECR authentication credentials via a AWS connector identified by its id. | Configurable | Refer to Amazon EC2 Container Registry (Amazon ECR) authentication credentials for details.
|
Frequently Asked Questions (FAQ)
Amazon Web Services™, AWS™ and the “Powered by Amazon Web Services” logo are trademarks of Amazon.com, Inc. or its affiliates in the United States and/or other countries.
Utoolity® is a registered trademark of Utoolity GmbH.
© 2024 Utoolity GmbH. All rights reserved.