Creating an AWS integration user

To create an AWS API Gateway integration on the Integrations screen, you will need to enter your AWS credentials.

Such credentials are configured on the AWS side.

Access the AWS Management Console and follow the steps below to:

  1. Create a user.

  2. Add an access policy.

  3. Create the credentials.


Creating user

There are several different ways to create an IAM user in your AWS account.

With the steps below, you can create a user through the AWS Management Console:

  1. At the top of the AWS Management Console, in the search bar, search for and select IAM.
    detail of the AWS Management Console search screen with the result for IAM search

  2. In the side menu, under Access management, select Users.
    AWS management panel screen with highlight on the Users option

  3. Click the Create user button in the top right corner of the screen.

  4. In the User name field, enter the value: developer_portal_integration_aws and click Next.
    AWS management panel screen with highlight on the user name field

  5. In Permissions options, select Attach policies directly and click Next.
    AWS management panel screen with highlight on adding policies

    In "Permissions policies", DO NOT select any Policy name.

  6. In Review and Create, review the information and click Create user.


Adding an access policy

  1. In the user list, select developer_portal_integration_aws
    user list showing the user created

  2. In the Permissions tab, under Permissions policies, click the Add Permissions button and then click Create inline policy.
    AWS management panel screen with the Permissions tab and Add permissions button highlighted

  3. In Policy editor, select the JSON tab.
    Policy editor screen with JSON tab

  4. Copy and paste the code below into the editor.

    {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "apigateway:GET"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}

or

{
	"Version": "2012-10-17",
	"Statement": [
		{
			"Sid": "VisualEditor0",
			"Effect": "Allow",
			"Action": [
				"apigateway:GET"
			],
			"Resource": [
				"arn:aws:apigateway:us-east-1::/restapis",
			              "arn:aws:apigateway:us-east-1::/restapis/api_id/*",
				"arn:aws:apigateway:us-east-1::/restapis/api_id/stages",
		"arn:aws:apigateway:us-east-1::/restapis/api_id/deployments",
				"arn:aws:apigateway:us-east-1::/restapis/api_id/deployments/*",
				"arn:aws:apigateway:us-east-1::/usageplans",
				"arn:aws:apigateway:us-east-1::/apikeys"
			]
		}
	]
}
    Depending on your business needs, there are specific policies that can be used.

  5. Click Next.

  6. In the Policy name field, enter the value developer_portal-aws and click Create policy.
    create and review screen


Creating the credentials

  1. In the user list, select developer_portal_integration_aws and click on the Security credentials tab.
    aws security credentials

  2. Scroll down and, under Access keys, click Create access key.
    aws create access key

  3. Select the option Application running on an AWS compute service.
    screen indicating the option

    Check the confirmation box at the bottom of the page.
    confirmation box

  4. Click on Next.

  5. You will see your access key and your secret access key.
    Take note of these credentials and use them when registering the AWS connection in Developer Portal.
    Retrieve access key screen

  6. Click on Done.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]