- unmigrated-wiki-markup
Documentation for Identity Federation for AWS 2.0 – other releases are available in the Identity Federation for AWS Documentation Directory.
View
or visit the current documentation home.
REST API v2 Reference
This is the Identity Federation for AWS REST API v1 reference, see the Developer's Guide for more information.
API Compatibility
Identity Federation for AWS strives to support the two latest API versions to provide an upgrade path:
On this page:
REST API v2 resources (Identity Federation)
This is the reference of all resources relevant to this add-ons actual functionality as a token vendor for Identity Federation - please see the REST API resources (complete reference) if you intent to include this add-on into administrative automation scenarios (e.g. for scripting).
Resource | URI template | methods | description | permissions | comments |
---|---|---|---|---|---|
Connectors | ![]() | ||||
GET | Get all AWS connectors. | Configurable | |||
/connectors/{id} | GET | Get an AWS connector identified by its id. | Configurable | . | |
/connectors/{id}/credentials | GET | Get the temporary AWS security credentials via a AWS connector identified by its id. | Configurable | ![]() |
/rest/identity-federation-for-aws/2.0/connectors
Methods
GET
GET http://host:port/context/rest/identity-federation-for-aws/2.0/connectors (200)
{ "values": [ { "id": "1521fbf0-fa97-4c4a-9877-9f0c5e9982d3", "name": "Development Team A", "type": "FEDERATION_TOKEN" }, { "id": "1f2d5aee-839e-49ae-8a5b-e9ae27a2f2d8", "name": "Development Team B", "type": "SESSION_TOKEN" }, { "id": "997a2479-a27c-46fc-9397-9a6bff91b7dd", "name": "Operations Team", "type": "FEDERATION_TOKEN" "scope": "SYSTEM" } ], "size": 3 }
/rest/identity-federation-for-aws/2.0/connectors/{id}
Methods
GET
GET http://host:port/context/rest/identity-federation-for-aws/2.0/connectors/1 (200)
{ "id": "1521fbf0-fa97-4c4a-9877-9f0c5e9982d3", "name": "Development Team A", "type": "FEDERATION_TOKEN" }
/rest/identity-federation-for-aws/2.0/connectors/{id}/credentials
Methods
GET
GET http://host:port/context/rest/identity-federation-for-aws/2.0/connectors/1/credentials (200)
{ "expiration": 1370423461000, "sessionToken": "AQoDYXdzEN7//////////wEa8AEmChyr2gLDNxQATlASOWNkI0ORBVCkbPuMdTPQxpQR7NrqxjBo+O13lg2KjKdsxoXfR3fzCG/L0g9k2YQOMWVZjQLkd6cS4F3NL3qa/dtheXaYmcCeUXwJoznMWsXvGV3OQyizKD7hHcQbrYDzJWr1hcoksx03NazuG1xx6uWn8uwcktsyMCwATlasC8tqw6ffozllgQr2eZK1lBPyXWQy7Jwx3EyXLP/rulAhEBE9mrAUzp0xq0Yiekc7I06dSAQT7fBsuHzWoNQ0O8zmX4S35AL+pP+kBzAJZ75qvviNZYmoqXCBcSEOmWLFnyAuCSUg5a+5jQU=", "accessKeyId": "ASIJATLAS2XBO2MQ77VQ", "secretAccessKey": "FeJioaEdLa0RJsVCSBYAtLaskADEzkq1VFriuJla" }
REST API v2 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 add-ons actual functionality first.
Resource | URI template | methods | description | permissions | comments |
---|---|---|---|---|---|
Accounts | ![]() | ||||
/accounts | GET|POST | Get all accounts (IAM users). | Administrator | ||
/accounts/{id} | GET|DELETE|PUT | Get an account (IAM user) identified by its id. | Administrator | ||
Connectors | ![]() | ||||
/connectors | GET | Get all AWS connectors. | Configurable | ![]() | |
/connectors/{id} | GET | Get an AWS connector identified by its id. | Configurable | ![]() | |
/connectors/{id}/credentials | GET | Get the temporary AWS security credentials via an AWS connector identified by its id. | Configurable | ![]() |