Skip to content
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.

Commit

Permalink
Update API.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fieldju authored Apr 4, 2017
1 parent a1e93dd commit 59ca3a0
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ This endpoint allows a user to exchange their current token for a new one with u

### Authenticate with Cerberus as an App [POST]

This endpoint will take a Users credentials and proxy the request to Vault to get a Vault token for the user with some extra metadata.
This endpoint takes IAM ARN information and generates an base 64 encoded KMS encrypted payload of the below. The ARN if registered with an SDB will have kms decrypt permissions on the KMS key that the payload was enrypted with.

+ Request (application/json)

Expand All @@ -166,6 +166,8 @@ This endpoint will take a Users credentials and proxy the request to Vault to ge
"metadata" : {
"aws_region" : "us-west-2",
"username" : "arn:aws:iam::933764306573:role/cerberus-api-tester"
"is_admin": "false",
"groups": "registered-iam-principals"
},
"lease_duration" : 3600,
"renewable" : true
Expand All @@ -176,7 +178,7 @@ This endpoint will take a Users credentials and proxy the request to Vault to ge

### Authenticate with Cerberus as an App [POST]

This endpoint will take a Users credentials and proxy the request to Vault to get a Vault token for the user with some extra metadata.
This endpoint takes IAM ARN information and generates an base 64 encoded KMS encrypted payload of the below. The ARN if registered with an SDB will have kms decrypt permissions on the KMS key that the payload was enrypted with.

+ Request (application/json)

Expand All @@ -196,10 +198,10 @@ This endpoint will take a Users credentials and proxy the request to Vault to ge
"client_token" : "234808f1-ede3-2177-aa9d-45f507391310",
"policies" : [ "health-check-bucket-read", "lookup-self" ],
"metadata" : {
"aws_account_id" : "111111111",
"aws_iam_role_name" : "cerberus-api-tester",
"aws_region" : "us-west-2",
"username" : "arn:aws:iam::111111111:role/cerberus-api-tester"
"username" : "arn:aws:iam::111111111:role/cerberus-api-tester",
"is_admin": "false",
"groups": "registered-iam-principals"
},
"lease_duration" : 3600,
"renewable" : true
Expand Down

0 comments on commit 59ca3a0

Please sign in to comment.