Get information on the specific AWS role object. 

NOTE: APIs for AWS roles apply only to instances of the that are hosted on AWS and configured for user mode of authentication.

For more information on how to use awsRole objects, see API Workflow - Manage AWS Configurations.


Version:  v4

Required Permissions

Request

Request Type: GET

Endpoint:

/v4/awsRoles/<id>

where:

ParameterDescription
<id>Internal identifier for the AWS role object


Request URI - Example:

/v4/awsRoles/2

Request Body:

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

{
  "id": 2,
  "awsConfig": {
    "id": 1
  },
  "role": "<IAM_ROLE_ARN>",
  "createdFrom": "api",
  "createdAt": "2019-07-15T18:39:33Z",
  "updatedAt": "2019-07-15T18:39:33Z",
  "deletedAt": "2019-07-15T18:39:33Z"
}

Reference

PropertyDescription
idInternal identifier of the AWS role object
awsConfig

Internal identifier of the AWS configuration object with which this AWS role object is associated.

roleThe AWS IAM role ARN associated with this object
createdFrom

Method by which the AWS role object was created. Possible values:

  • api - Role was created using this API endpoint.
  • idp - Role was provided by the integrated identity provider.
createdAtTimestamp for when the AWS role object was launched
updatedAtTimestamp for when the AWS role object was last updated
deletedAtTimestamp for when the AWS role object was deleted