Identity Federation for AWS is mainly a system integration and API add-on, which exposes resources via a REST API - all resources can be used like the regular JIRA REST API and are exposed via an URL keyed by the add-on namespace:
/jira/rest/identity-federation-aws/1.0
REST API Browser
The easiest way to explore the API is by means of the Atlassian REST API Browser, simply select the Identity Federation for AWS resources.
On this page:
REST API resources
Resource | URI template | methods | description | permissions | comments |
---|---|---|---|---|---|
Accounts | You usually won't interact with accounts via the API currently, please see the Connectors resource instead! | ||||
/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 | This is the main resource to interact with currently in order to retrieve temporary AWS credentials. | ||||
/connectors | GET | 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 | 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}/credentials | GET | Get the temporary security credentials via an AWS connector identified by its id. | Configurable | This is the main resource to use for calling AWS Services in turn. |