Versions Compared

Old Version 1

changes.mady.by.user Steffen Opel [Utoolity]

Saved on

compared with

New Version Current

changes.mady.by.user Steffen Opel [Utoolity]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated reference to included page.
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

Column
width32%
Panel
bgColor#eeeeee

On this page:

Table of Contents
maxLevel3

 

REST API 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 Page
this add-on into administrative automation scenarios (e.g. for scripting).

ResourceURI templatemethodsdescriptionpermissionscomments
Connectors    (plus) This is the main resource to interact with currently in order to retrieve temporary AWS security credentials.
 

/connectors

GETGet all AWS connectors.Configurable 
 /connectors/{id}GETGet an AWS connector identified by its id.Configurable.
  /connectors/{id}/credentialsGETGet the temporary AWS security credentials via a AWS connector identified by its id.Configurable(lightbulb) This is the main resource to use for calling AWS services in turn.

 

 

...

/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

...

 

 

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": 2,
  "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 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.

...

/connectors

...

...

{
  "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
}

_APIReferenceV2
_APIReferenceV2