Documentation for Identity Federation for AWS 2.6 – other releases are available in the Identity Federation for AWS Documentation Directory.
View

Unknown macro: {spacejump}

or visit the current documentation home.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

In order to enable access to your AWS resources, you need to create at least one AWS Connector. You can access this functionality via the AWS Connectors configuration screen.

On this page:

AWS Security Credentials Variations

The add-on currently supports the following Principal Types:

Capabilities and Restrictions

Each Principal Type has different capabilities and restrictions regarding credential lifetime, Single Sign-On (SSO) to the AWS Management Console, Multi-Factor Authentication (MFA) and calling the IAM and STS APIs in turn, see Comparing Features of AWS STS APIs for details.


Principal TypeAWS DocumentationAPI actionCredential lifetime (min/max/default)Notes
(tick)Federated UserTemporary Security Credentials to Enable Access for Federated UsersGetFederationToken

IAM user: 15m/36hr/12hr

Root account: 15m/1hr/1hr


(tick)Assume RoleTemporary Security Credentials for Delegating API AccessAssumeRole15m/1hr/1hr


(tick)IAM UserTemporary Security Credentials to Enable Access for IAM UsersGetSessionToken

IAM user: 15m/36hr/12hr

Root account: 15m/1hr/1hr


(error)SAML FederationTemporary Security Credentials for SAML FederationAssumeRoleWithSAML15m/1hr/1hrSupport for SAML is not on our roadmap, see the resp. FAQ for details

Create/Edit Connector

To configure an AWS Connector:

  1. Navigate to the Identity Federation for AWS configuration.
  2. Click Edit for an existing AWS Connector, or click Create Connector to create a new one.


Complete the following settings:

Account (IAM User) Select the long-term AWS security credentials to derive temporary AWS security credentials from - see also add/edit accounts below.
Connector Name

Specify a custom name to identify this connector.

Principal Type

Select one of the supported principal types:

Principal TypeExplanationCredential lifetime (min/max/default)Learn more at AWS
Federated User

Yields temporary AWS security credentials for a federated user with the Atlassian user name and an optional, yet typically required IAM Policy (check Omit IAM Policy when resource-based policies are used instead)

In order to use the Federated User principal type, you need to Grant an IAM Group Permission to Create Temporary Credentials! This example policy grants permission to access the AWS STS GetFederationToken API once added to the long-term AWS security credentials you are about to use for federation (i.e. not here in this AWS Connector dialog):

Example IAM Policy
{
  "Version": "2012-10-17",
  "Statement": [{
    "Effect": "Allow",
    "Action": "sts:GetFederationToken",
    "Resource": "*"
  }]
}
Federated User does not allow to access IAM or STS APIs, for example when creating IAM resources via CloudFormation - use Assume Role for these scenarios instead.

IAM user: 15m/36hr/12hr

Root account: 15m/1hr/1hr

Assume Role

Yields temporary AWS security credentials for an assumed role with the Atlassian user name and an optional External ID and an optional IAM Policy (if absent, AWS applies a default)

In order to use the Assume Role principal type, you need to Grant an IAM Group Permission to Create Temporary Credentials! This example policy grants permission to access the AWS STS AssumeRole API once added to the long-term AWS security credentials you are about to use for federation (i.e. not here in this AWS Connector dialog):

Example IAM Policy
{
  "Version": "2012-10-17",
  "Statement": [{
    "Effect": "Allow",
    "Action": "sts:AssumeRole",
    "Resource": "arn:aws:iam::123123123123:role/UpdateAPP"
  }]
}
15m/1hr/1hr
IAM User (session token)

Yields temporary AWS security credentials for the selected IAM user (recommended) or AWS account (disadvised) itself

IAM User (session token) does not allow to specify IAM policies or distinguish users - use Federated User or Assume Role for these scenarios instead.

IAM user: 15m/36hr/12hr

Root account: 15m/1hr/1hr

IAM Policy(Conditional) Specify an IAM Policy (supported for principal types Federated User and Assume Role)
  • (lightbulb) Clicking on 'IAM Policy Examples' allows you to select from a few example policies to ease getting started (just click one to copy it to the policy field) - links to the AWS Policy Generator and the IAM Policy Simulator are also provided.
Maximum Duration

(Optional) Set the maximum number of seconds temporary credentials based on this connector can be valid - leave empty to use AWS default values

Groups
(Optional) Grant the permission to use this Connector to one or more of your JIRA or Bamboo groups:

Administrators always have permission to use all Connectors.

  1. click into the selection box to search for groups
    • (info) Bamboo < 5.6 and JIRA < 6.2 feature a different user interface for group selection still, see  UAA-89 - Getting issue details... STATUS  for details.
  2. start typing to narrow down the selection

    Performance with more than 100 groups

    If there are more than 100 groups, you need to type at least one character to make all matching groups appear.

    (warning) Depending on the number of groups and naming scheme paired with browser and system performance, frequently used characters like 'e' might still yield slightly sluggish behavior - typing quickly should circumvent such sluggishness, if any!

  3. select each desired group

    • (warning) all changes persist on save of the connector only

Scope(Optional) Select System Scope to allow usage of this AWS Connector from elevated code without an active user session (e.g. by other add-ons like Tasks for AWS and Automation with AWS).




Add/Edit Account

In order to create AWS Connectors, you need to add at least one account resp. IAM User, which provides the required long-term AWS security credentials used to derive temporary AWS security credentials for your Atlassian users, see Create individual IAM users for getting started with this approach.

Required IAM Permissions

The Federated User and Assume Role principal types require Permissions to Create Temporary Credentials - see the Principal Types table above for details.

To configure an Account (IAM User):

  1. Navigate to the Identity Federation for AWS configuration.
  2. Click Edit for an existing AWS Connector, or click Create Connector to create a new one.
  3. Click Edit for an existing Account (IAM User), or click Add Account to create a new one.

Complete the following settings:

Account NameSpecify a custom name to identify this account.
Access Key ID

Provide the Access Key ID of your long-term AWS Security Credentials.

Secret Access Key
Provide the Secret Access Key of your long term AWS Security Credentials.


How-to Articles

Filter by label

There are no items with the selected labels at this time.

Frequently Asked Questions (FAQ)


  • No labels