| Section |
|---|
| Column |
|---|
| Identity Federation for AWS is a foundational Amazon Web Services (AWS) integration add-on, which exposes resources via a REST API - this is the developer's guide to the Identity Federation for AWS REST API for developers who want to: - integrate Atlassian products with AWS based DevOps scenarios
- develop add-ons that enhance an Atlassian product's functionality by means of integrating AWS backed services
|
|
Getting started
The Identity Federation for AWS REST API is based on open standards, so you can use any web development language or command line tool capable of generating an HTTP request to access the API, e.g. the popular cURL (a CLI tool for transferring data with URL syntax) or the highly recommended HTTPie (a CLI, cURL-like tool for humans). All resources can be used like the regular JIRA REST API (or Stash REST API, see info below):
| Tip |
|---|
|
The easiest way to explore and experiment with the Identity Federation for AWS API is by means of the Atlassian REST API Browser, simply select the Identity Federation for AWS resources. |
| Include Page |
|---|
| _ARADGComplianceNote |
|---|
| _ARADGComplianceNote |
|---|
|
Structure of the REST URIs
The Identity Federation for AWS REST API provides access to resources (data entities) via URI paths. To use the REST API, your application will make an HTTP request and parse the response. The Identity Federation for AWS REST API uses JSON as its communication format, and the standard HTTP methods like GET, PUT, POST and DELETE. URIs for Identity Federation for AWS REST API resources are keyed by the add-on namespace and have the following structure:
| Code Block |
|---|
http://host:port/context/rest/identity-federation-aws/1.0 |
...
| 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. |
| | /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 a AWS connector identified by its id. | Configurable |  This is the main resource to use for calling AWS Services services in turn. |
| Panel |
|---|
/rest/identity-federation-aws/1.0/connectorsMethodsGET| Code Block |
|---|
| theme | RDark |
|---|
| language | javascript |
|---|
| title | Request |
|---|
| GET http://host:port/context/rest/identity-federation-aws/1.0/connectors (200) |
| Code Block |
|---|
| theme | RDark |
|---|
| language | javascript |
|---|
| title | Response Headers |
|---|
| collapse | true |
|---|
| 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 |
| Code Block |
|---|
| theme | RDark |
|---|
| language | javascript |
|---|
| title | Response Body |
|---|
| {
"values": [
{
"id": 1,
"name": "Development Team A",
"type": "FEDERATION_TOKEN"
},
{
"id": 2,
"name": "Development Team B",
"type": "SESSION_TOKEN"
},
{
"id": 3,
"name": "Operations Team",
"type": "FEDERATION_TOKEN"
}
],
"size": 3
} |
|
...
| Panel |
|---|
/rest/identity-federation-aws/1.0/connectors/{id}MethodsGET| Code Block |
|---|
| theme | RDark |
|---|
| language | javascript |
|---|
| title | Request |
|---|
| GET http://host:port/context/rest/identity-federation-aws/1.0/connectors/21 (200) |
| Code Block |
|---|
| theme | RDark |
|---|
| language | javascript |
|---|
| title | Response Headers |
|---|
| collapse | true |
|---|
| Server: Apache-Coyote/1.1
X-AREQUESTID: 1390x1780x1
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:10:08 GMT |
| Code Block |
|---|
| theme | RDark |
|---|
| language | javascript |
|---|
| title | Response Body |
|---|
| {
"id": 2,
"name": "Development Team BA",
"type": "SESSIONFEDERATION_TOKEN"
} |
|
| Panel |
|---|
/rest/identity-federation-aws/1.0/connectors/{id}/credentialsMethodsGET| Code Block |
|---|
| theme | RDark |
|---|
| language | javascript |
|---|
| title | Request |
|---|
| GET http://host:port/context/rest/identity-federation-aws/1.0/connectors/21/credentials (200) |
| Code Block |
|---|
| theme | RDark |
|---|
| language | javascript |
|---|
| title | Response Headers |
|---|
| collapse | true |
|---|
| Server: Apache-Coyote/1.1
X-AREQUESTID: 1390x1782x1
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:10:56 GMT |
| Code Block |
|---|
| theme | RDark |
|---|
| language | javascript |
|---|
| title | Response Body |
|---|
| {
"expiration": 1370423461000,
"sessionToken": "AQoDYXdzEN7//////////wEa8AEmChyr2gLDNxQATlASOWNkI0ORBVCkbPuMdTPQxpQR7NrqxjBo+O13lg2KjKdsxoXfR3fzCG/L0g9k2YQOMWVZjQLkd6cS4F3NL3qa/dtheXaYmcCeUXwJoznMWsXvGV3OQyizKD7hHcQbrYDzJWr1hcoksx03NazuG1xx6uWn8uwcktsyMCwATlasC8tqw6ffozllgQr2eZK1lBPyXWQy7Jwx3EyXLP/rulAhEBE9mrAUzp0xq0Yiekc7I06dSAQT7fBsuHzWoNQ0O8zmX4S35AL+pP+kBzAJZ75qvviNZYmoqXCBcSEOmWLFnyAuCSUg5a+5jQU=",
"accessKeyId": "ASIJATLAS2XBO2MQ77VQ",
"secretAccessKey": "FeJioaEdLa0RJsVCSBYAtLaskADEzkq1VFriuJla"
} |
|
...
You usually won't interact with accounts via the API currently, please see the Connectors resource instead!
You only need GET for the intended usage as a token vendor, but POST will be added in a subsequent release regardless.