stormkeeper

stormkeeper provides support for managing Auth Tokens requested by BiS components

stormkeeper

Manages auth tokens provided by the BiS component

List of stormkeeper APIs

MethodURIDescription
POST/rulesCreate a rule entry and respond with rule UUID
GET/rulesGet details of all rules defined for each role
GET/rules/:idGet details of a specific rule
DELETE/rules/:idDelete a specific rule
POST/tokensCreate a token entry and respond with token UUID
GET/tokens/:idGet details of a specific token
DELETE/tokens/:idDelete a specific token

POST Rules API

Verb URI Description POST /rules Creates the Rules configuration.

On success it returns JSON data with the UUID with the rules configuration.

Example Request and Response

{
"name":"admin1",
"rules":["POST /domains/:id/policies”,"PUT /domains/:id/policies/:id”,"GET /domains/:id/policies”,"POST /domains/:id/metapolicy/:id/groups”], 
"role":"admin"
}
{
    "name": "admin1",
    "rules": [
        "POST /domains/:id/policies",
        "PUT /domains/:id/policies/:id",
        "GET /domains/:id/policies",
        "POST /domains/:id/metapolicy/:id/groups"
    ],
    "role": "admin1",
    "id": "25af4100-391b-4f46-b0c9-6774cedce6f8"
}

GET List API

Verb URI Description GET /rules List summary of rules configured.

Example Request and Response

GET http://stormkeeper:8333/rules

[
    {
    "name": "specific",
    "rules": [
    "POST /domains/:id/policies",
        "PUT /domains/:id/policies/:id",
    "GET /domains/:id/policies",
    "POST /domains/:id/metapolicy/:id/groups"
     ],
     "role": "admin",
     "id": "05686306-0db7-4bd2-98fb-19a0e0440f19"
    },
    {
    "name": "specific",
    "rules": [
        "GET /agents/serialkey/:key",
        "GET /agents/:id/bolt",
        "POST /agents/:id/csr"
    ],
    "role": "agent",
    "id": "3daeffb0-d83d-43a6-ab9c-e56600be677b"
    },
    {
    "name": "super",
    "rules": [
        "*"
        ],
    "role": "super-admin",
    "id": "063c8c14-dec2-4859-9a96-a413b06f1e0d"
    },
    {
    "name": "admin1",
    "rules": [
         "POST /domains/:id/policies",
         "PUT /domains/:id/policies/:id",
         "GET /domains/:id/policies",
         "POST /domains/:id/metapolicy/:id/groups"
         ],
     "role": "admin1",
     "id": "83997da9-63d7-46e6-aea0-7a44e8ce951b"
    },
    {
    "name": "admin1",
     "rules": [
         "POST /domains/:id/policies",
         "PUT /domains/:id/policies/:id",
         "GET /domains/:id/policies",
         "POST /domains/:id/metapolicy/:id/groups"
         ],
     "role": "admin1",
     "id": "fcb60644-8ced-4a91-beca-c5ecf0ac84ae"
    }
]

GET List API

Verb URI Description GET /rules/:id List summary of a specific rule.

Example Request and Response

GET http://stormkeeper:8333/rules/:id

{
    "name": "admin1",
    "rules": [
        "POST /domains/:id/policies",
        "PUT /domains/:id/policies/:id",
        "GET /domains/:id/policies",
        "POST /domains/:id/metapolicy/:id/groups"
    ],
    "role": "admin1",
    "id": "fcb60644-8ced-4a91-beca-c5ecf0ac84ae"
}

DELETE Rules API

Verb URI Description DELETE /rules/:id Delete existing rules configuration by ID.

Example Request and Response

DELETE http://stormkeeper:8333/rules/:id

Status Code : 204 No Content

POST Tokens API

Verb URI Description POST /tokens Creates the Tokens configuration.

On success it returns JSON data with the UUID with the tokens configuration.

Example Request and Response

{
"name":"token1",
"domainId":"abcdc127-bf53-44a6-9bc4-46e0d293efgh", 
"identityId":"ijklc127-bf53-44a6-9bc4-46e0d293mnop",
"ruleId":"05686306-0db7-4bd2-98fb-19a0e0440f19",
"validity":300,
"lastModified":"timestamp",
"userData":[{"accountId":"qrstc127-bf53-44a6-9bc4-46e0d293zkmn","userEmail":"sbusa@clearpathnet.com"}]
}
{
"name": "token1",
"domainId": "abcdc127-bf53-44a6-9bc4-46e0d293efgh",
"identityId": "ijklc127-bf53-44a6-9bc4-46e0d293mnop",
"ruleId": "05686306-0db7-4bd2-98fb-19a0e0440f19",
"validity": 300,
"lastModified": "timestamp",
"userData": [
{
    "accountId": "qrstc127-bf53-44a6-9bc4-46e0d293zkmn",
    "userEmail": "sbusa@clearpathnet.com"
}
],
"id": "c58bcee8-cafe-4f46-bf24-d4e01347ed68"
} 

GET List API

Verb URI Description GET /tokens/:id List summary of a specific token.

Example Request and Response

GET http://stormkeeper:8333/tokens/:id

{
"id": "3964ca98-a13a-4618-af5c-70df002929ed",
"userData": [
{
    "accountId": "qrstc127-bf53-44a6-9bc4-46e0d293zkmn",
    "userEmail": "sivaprasathb@calsoftlabs.com"
}
],
"lastModified": "timestamp",
"validity": 80,
"ruleId": "3daeffb0-d83d-43a6-ab9c-e56600be677b",
"identityId": "ijklc127-bf53-44a6-9bc4-46e0d293mnop",
"domainId": "abcdc127-bf53-44a6-9bc4-46e0d293efgh",
"name": "siva",
"rule": {
    "name": "specific",
    "rules": [
    "GET /agents/serialkey/:key",
    "GET /agents/:id/bolt",
    "POST /agents/:id/csr"
    ],
    "role": "agent",
    "id": "3daeffb0-d83d-43a6-ab9c-e56600be677b"
}
} 

DELETE Tokens API

Verb URI Description DELETE /tokens/:id Delete existing tokens configuration by ID.

Example Request and Response

DELETE http://stormkeeper:8333/tokens/:id

Status Code : 204 No Content