Awsroles

get/role-store/api/v1/awsroles

Get all AWS roles from all sources

refreshboolean

Refresh the aws roles from AWS directories before fetching.

Responses

Response examples

Successful response, returns an array of found AWS roles, returns an empty array if no roles are defined

[
  {
    "id": "514510fe-1531-530f-63c6-3f80cea33fdc",
    "name": "My Own AWS Role",
    "arn": "arn:aws:iam::123456789012:role/role-name",
    "updated": "2017-01-01T15:05:05Z",
    "description": "string",
    "source": "514510fe-1531-530f-63c6-3f80cea33fdc",
    "status": "OK",
    "roles": [
      {
        "id": "5bf77342-221c-11ee-be56-0242ac120002",
        "name": "string"
      }
    ]
  }
]

get/role-store/api/v1/awsroles/{awsrole_id}

Get role object by ID.

awsrole_idstring

required

Role ID

Responses

Response examples

Successful response, returns a role if found

{
  "id": "514510fe-1531-530f-63c6-3f80cea33fdc",
  "name": "My Own AWS Role",
  "arn": "arn:aws:iam::123456789012:role/role-name",
  "updated": "2017-01-01T15:05:05Z",
  "description": "string",
  "source": "514510fe-1531-530f-63c6-3f80cea33fdc",
  "status": "OK",
  "roles": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string"
    }
  ]
}

delete/role-store/api/v1/awsroles/{awsrole_id}

Delete cached AWS role and its mappings on PrivX. Does not affect the AWS service, if the role still exists on AWS, it will re-appear on the next role scan.

awsrole_idstring

required

Role ID

Responses

Response examples

Successful deletion

Empty response

get/role-store/api/v1/awsroles/{awsrole_id}/roles

Get AWS role granting PrivX roles.

awsrole_idstring

required

AWS role ID

Responses

Response examples

Successful response, returns list of mapped PrivX roles

{
  "count": 123,
  "items": [
    {
      "id": "514510fe-1531-530f-63c6-3f80cea33fdc",
      "name": "My Own AWS Role",
      "arn": "arn:aws:iam::123456789012:role/role-name",
      "updated": "2017-01-01T15:05:05Z",
      "description": "string",
      "source": "514510fe-1531-530f-63c6-3f80cea33fdc",
      "status": "OK",
      "roles": [
        {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "string"
        }
      ]
    }
  ]
}

put/role-store/api/v1/awsroles/{awsrole_id}/roles

Update a AWS role granting PrivX roles.

Array of objects

idstring

PrivX role id

Format: uuid

Responses

Request examples

[
  {
    "id": "5bf77342-221c-11ee-be56-0242ac120002"
  }
]

Response examples

Role successfully updated

Empty response