Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated to API v1 as of release 2.0.0.
Section
Column
width64%

This is the Identity Federation for AWS REST API v1 reference, see the Developer's Guide for more information.

Include Page
_APICompatibilityNote
_APICompatibilityNote

Note
titleDeprecation Note

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

Changes / Upgrade Path
  • 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
Column
width32%
Panel
bgColor#eeeeee

On this page:

Table of Contents
maxLevel3

 

REST API v1 resources (Identity Federation)

This is the reference of all resources relevant to this add-ons actual functionality as a 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).

...

Panel

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

Methods

GET
Code Block
themeRDark
languagejavascript
titleRequest
GET http://host:port/context/rest/identity-federation-aws/1.0/connectors (200)
Code Block
themeRDark
languagejavascript
titleResponse Headers
collapsetrue
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
themeRDark
languagejavascript
titleResponse 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
}

...

Panel

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

Methods

GET
Code Block
themeRDark
languagejavascript
titleRequest
GET http://host:port/context/rest/identity-federation-aws/1.0/connectors/1 (200)
Code Block
themeRDark
languagejavascript
titleResponse Headers
collapsetrue
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
themeRDark
languagejavascript
titleResponse Body
{
  "id": 1,
  "id2": 2"1f2d5aee-839e-49ae-8a5b-e9ae27a2f2d8",
  "name": "Development Team A",
  "type": "FEDERATION_TOKEN"
}

...

Panel

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

Methods

GET
Code Block
themeRDark
languagejavascript
titleRequest
GET http://host:port/context/rest/identity-federation-aws/1.0/connectors/1/credentials (200)
Code Block
themeRDark
languagejavascript
titleResponse Headers
collapsetrue
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
themeRDark
languagejavascript
titleResponse 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.

...