> For the complete documentation index, see [llms.txt](https://hawkins.gitbook.io/consoleme/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hawkins.gitbook.io/consoleme/configuration/role-credential-authorization.md).

# Role Credential Authorization

ConsoleMe generates a credential authorization mapping that helps it determine **who** (which users or groups) can access **what** IAM roles. It can use a combination of [IAM role tags](/consoleme/configuration/role-credential-authorization/role-tagging-recommended.md) and [dynamic configuration](/consoleme/configuration/role-credential-authorization/dynamic-configuration-1.md). Organizations can also write an [internal plugin](/consoleme/configuration/role-credential-authorization/custom-authorization-internal-plugin.md) to produce a credential authorization mapping with custom logic. This is configurable, so you can pick and choose which of these methods you will use to generate your mapping.

The mapping generated by ConsoleMe looks like the following:

```
{
  "group@example.com": {
        "authorized_roles": [
          "arn:aws:iam::123456789012:role/ConsoleRole"
        ],
        "authorized_roles_cli_only": []
      },
  "user@example.com": {
    "authorized_roles": [],
    "authorized_roles_cli_only": [
      "arn:aws:iam::123456789012:role/ApplicationRole"
    ]
  }
}
```

When a user authenticates, ConsoleMe combines all of the roles they're authorized to access based on the user's username and their group memberships.

The roles listed under `authorized_roles` will be shown to the user in ConsoleMe. They'll be able to log in to the AWS Console with the role, and they can also retrieve credentials for the role via the CLI ([Weep](/consoleme/weep-cli/cli.md)).

The roles listed under `authorized_roles_cli_only` will **not** be shown to the user in ConsoleMe. However, they'll be able to retrieve credentials via the CLI. Typically, application roles will be listed under this key.

## Configuration

Here's an example configuration that enables all of the flows:

```
cloud_credential_authorization_mapping:
  role_tags:
    enabled: true
    required_trust_policy_entity: arn:aws:iam::123456789012:role/consolemeInstanceProfile
    authorized_groups_tags:
      - consoleme-authorized-groups-for-credentials
    authorized_groups_cli_only_tags:
      - consoleme-owner
      - consoleme-authorized-groups-for-credentials-cli-only
  dynamic_config:
    enabled: true
  internal_plugin:
    enabled: true
```

The key `cloud_credential_authorization_mapping.role_tags.required_trust_policy_entity` is an optional configuration value that, if provided, will **not** include an IAM role in the authorization mapping if it does not allow ConsoleMe to assume the role. You'd need to change this value to the IAM role used by ConsoleMe at your organization.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://hawkins.gitbook.io/consoleme/configuration/role-credential-authorization.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.