REST API v1 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:

Deprecation Note

The Identity Federation for AWS REST API v1 is deprecated, please use the REST API v2 going forward.

Changes / Upgrade Path

the REST API v1 remains supported in Identity Federation for AWS 2.x and will be removed once a REST API v3 will be published
attribute id has been changed to a GUID in v2 - to allow for upgrades, the same GUID is exposed as id2 within the v1 API too
the Marketplace enforced split of the add-on into dedicated ones per Atlassian application required us to change the base path for the REST API v1 resources from /rest/identity-federation-for-aws/1.0 to /rest/identity-federation-for-aws/1.0 in Identity Federation for AWS 2.x (Identity Federation for AWS 1.x remains unchanged) - please ensure to adjust this in case you need to keep existing v1 clients working with Identity Federation for AWS 2.x

On this page:

REST API v1 resources (Identity Federation)

This is the reference of all resources relevant to this add-ons actual functionality as a token vendor for Identity Federation - refer to 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					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 a AWS connector identified by its id.	Configurable	This is the main resource to use for calling AWS services in turn.

/rest/identity-federation-for-aws/1.0/connectors

Methods

GET

Request

GET http://host:port/context/rest/identity-federation-for-aws/1.0/connectors (200)

Response Headers

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

Response Body

{
  "values": [
    {
      "id": 1,
      "id2": "1f2d5aee-839e-49ae-8a5b-e9ae27a2f2d8",
      "name": "Development Team A",
      "type": "FEDERATION_TOKEN"
    },
    {
      "id": 2,
      "id2": "1521fbf0-fa97-4c4a-9877-9f0c5e9982d3",
      "name": "Development Team B",
      "type": "SESSION_TOKEN"
    },
    {
      "id": 3,
      "id2": "bddc8430-cea7-4e09-98f6-354edcb841c4",
      "name": "Operations Team",
      "type": "FEDERATION_TOKEN"
    }
  ],
  "size": 3
}

/rest/identity-federation-for-aws/1.0/connectors/{id}

Methods

GET

Request

GET http://host:port/context/rest/identity-federation-for-aws/1.0/connectors/1 (200)

Response Headers

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

Response Body

{
  "id": 1,
  "id2": "1f2d5aee-839e-49ae-8a5b-e9ae27a2f2d8",
  "name": "Development Team A",
  "type": "FEDERATION_TOKEN"
}

/rest/identity-federation-for-aws/1.0/connectors/{id}/credentials

Methods

GET

Request

GET http://host:port/context/rest/identity-federation-for-aws/1.0/connectors/1/credentials (200)

Response Headers

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

Response Body

{
  "expiration": 1370423461000,
  "sessionToken": "AQoDYXdzEN7//////////wEa8AEmChyr2gLDNxQATlASOWNkI0ORBVCkbPuMdTPQxpQR7NrqxjBo+O13lg2KjKdsxoXfR3fzCG/L0g9k2YQOMWVZjQLkd6cS4F3NL3qa/dtheXaYmcCeUXwJoznMWsXvGV3OQyizKD7hHcQbrYDzJWr1hcoksx03NazuG1xx6uWn8uwcktsyMCwATlasC8tqw6ffozllgQr2eZK1lBPyXWQy7Jwx3EyXLP/rulAhEBE9mrAUzp0xq0Yiekc7I06dSAQT7fBsuHzWoNQ0O8zmX4S35AL+pP+kBzAJZ75qvviNZYmoqXCBcSEOmWLFnyAuCSUg5a+5jQU=",
  "accessKeyId": "ASIJATLAS2XBO2MQ77VQ",
  "secretAccessKey": "FeJioaEdLa0RJsVCSBYAtLaskADEzkq1VFriuJla"
}

REST API v1 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					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 security 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 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.