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 awsRoles, 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

For more information, see API AWSRoles Get List v4.