This is the multi-page printable view of this section. Click here to print.
Get role list
1 - 1.4
scp-cli iam role list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--role_type <value>]
[--account_id <value>]
[--exclude_policy_id <value>]
Description
Get role list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Role Name | - |
| role_type optional | string | Role Type | - |
| account_id optional | string | Account ID | - |
| exclude_policy_id optional | string | Policy Exception | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role Type |
2 - 1.3
scp-cli iam role list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--role_type <value>]
[--account_id <value>]
[--exclude_policy_id <value>]
Description
Get role list
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Role Name | - |
| role_type optional | string | Role Type | - |
| account_id optional | string | Account ID | - |
| exclude_policy_id optional | string | Policy Exception | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role Type |
3 - 1.2
scp-cli iam role list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--role_type <value>]
[--account_id <value>]
[--exclude_policy_id <value>]
Description
Get role list
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Role Name | - |
| role_type optional | string | Role Type | - |
| account_id optional | string | Account ID | - |
| exclude_policy_id optional | string | Policy Exception | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role Type |
4 - 1.1
scp-cli iam role list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--role_type <value>]
[--account_id <value>]
[--exclude_policy_id <value>]
Description
Get role list
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Role Name | - |
| role_type optional | string | Role Type | - |
| account_id optional | string | Account ID | - |
| exclude_policy_id optional | string | Policy Exception | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role Type |
5 - 1.0
scp-cli iam role list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--role_type <value>]
[--account_id <value>]
[--exclude_policy_id <value>]
Description
Get role list
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Role Name | - |
| role_type optional | string | Role Type | - |
| account_id optional | string | Account ID | - |
| exclude_policy_id optional | string | Policy Exception | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role Type |