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

...


Version: 
v4

Required Permissions

At least one of the following roles is required to use this endpoint:

  • Workspace admin

  • d-s-

...

  • item
    itemadmin

...

Request

Request Type: POST

...

The following is an example request for such an AWS roles object. The IAM role arn is associated with the specific AWS configuration object:

Code Block
{
  "awsConfigrole": "<my_iam_role_arn>"
}

Request Body with assignment:

When you create an AWS role object, you can optionally pass in a person or workspace identifier. Based on this identifier, the 

D s platform
 attempts to assign the new object to the appropriate person or workspace identifiers through the referenced AWS configuration object.

Person Id:

Code Block
{
  "role": "<my_iam_role_arn>",
  "idpersonId": 299
  },}

Workspace Id:

Code Block
{
  "role": "<my_iam_role_arn>",
  "workspaceId": 1
}

Response

Response Status Code - Success:  201 - Created

Response Body:

Code Block
{
    "createdFrom": "api",
    "id": 1,
    "role": "<my_iam_role_arn>",
    "awsConfig": {
      "idawsConfigId": 2
    },
    "updatedAt": "2019-07-15T23:18:59.360Z",
    "createdAt": "2019-07-15T23:18:59.360Z",
    "deleted_at": null
}

Reference

For more information, see API AWSRoles Get List v4.