Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DEV and version r0682

D s api version

D toc

Get information on all available AWS role objects. 

Info

NOTE: APIs for AWS roles apply only to instances of the

D s platform
rtrue
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

D s api auth

Request

Request Type: GET

Endpoint:

Code Block
/v4/awsRoles/

Request URI - Example:

Code Block
/v4/awsRoles

Request Body:

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

Code Block
{
    "data": [
        {
            "id": 2,
            "role": "<my_iam_role_arn_9",
            "createdFrom": "api",
            "createdAt": "2019-07-15T23:18:59.360Z",
            "updatedAt": "2019-07-15T23:34:31.191Z",
            "awsConfigId": 3
        },
        {
            "id": 1,
            "role": "string4",
            "role": "<my_iam_role_arn_8",
            "createdAt": "2019-07-15T23:18:59.360Z",
            "updatedAt": "2019-07-15T23:34:31.191Z",
            "awsConfigId": 1
        }
    ]
}

Reference

PropertyDescription
idInternal identifier of the AWS role object
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
awsConfigId

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