This is the multi-page printable view of this section. Click here to print.
List Groups
1 - 1.3
scpcli iam group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--types <value>]
[--ids <value>]
[--has_member <value>]
[--has_role <value>]
[--is_completed <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_user_id <value>]
[--exclude_policy_id <value>]
Description
List Groups
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
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 | Group Name | TestGroup |
| types optional | string | Group Types | USER_DEFINED,DEFAULT |
| ids optional | string | Group ID List | 629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765 |
| has_member optional | string | Group Member Existence | false |
| has_role optional | string | Group Role Existence | false |
| is_completed optional | string | Group Completion Status | false |
| creator_name optional | string | Creator Last Name, First Name | Kim Samsung |
| creator_email optional | string | Creator Email | samsung.kim@samsung.com |
| modifier_name optional | string | Modifier Last Name, First Name | Kim Samsung |
| modifier_email optional | string | Modifier Email | samsung.kim@samsung.com |
| exclude_user_id optional | string | User ID to Exclude | f39c460fade34fecb05ede8f904b24b7 |
| exclude_policy_id optional | string | Policy ID to Exclude | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_DEFINED |
2 - 1.2
scpcli iam group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--types <value>]
[--ids <value>]
[--has_member <value>]
[--has_role <value>]
[--is_completed <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_user_id <value>]
[--exclude_policy_id <value>]
Description
List Groups
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 | Group Name | TestGroup |
| types optional | string | Group Types | USER_DEFINED,DEFAULT |
| ids optional | string | Group ID List | 629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765 |
| has_member optional | string | Group Member Existence | false |
| has_role optional | string | Group Role Existence | false |
| is_completed optional | string | Group Completion Status | false |
| creator_name optional | string | Creator Last Name, First Name | Kim Samsung |
| creator_email optional | string | Creator Email | samsung.kim@samsung.com |
| modifier_name optional | string | Modifier Last Name, First Name | Kim Samsung |
| modifier_email optional | string | Modifier Email | samsung.kim@samsung.com |
| exclude_user_id optional | string | User ID to Exclude | f39c460fade34fecb05ede8f904b24b7 |
| exclude_policy_id optional | string | Policy ID to Exclude | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_DEFINED |
3 - 1.1
scpcli iam group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--types <value>]
[--ids <value>]
[--has_member <value>]
[--has_role <value>]
[--is_completed <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_user_id <value>]
[--exclude_policy_id <value>]
Description
List Groups
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 | Group Name | TestGroup |
| types optional | string | Group Types | USER_DEFINED,DEFAULT |
| ids optional | string | Group ID List | 629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765 |
| has_member optional | string | Group Member Existence | false |
| has_role optional | string | Group Role Existence | false |
| is_completed optional | string | Group Completion Status | false |
| creator_name optional | string | Creator Last Name, First Name | Kim Samsung |
| creator_email optional | string | Creator Email | samsung.kim@samsung.com |
| modifier_name optional | string | Modifier Last Name, First Name | Kim Samsung |
| modifier_email optional | string | Modifier Email | samsung.kim@samsung.com |
| exclude_user_id optional | string | User ID to Exclude | f39c460fade34fecb05ede8f904b24b7 |
| exclude_policy_id optional | string | Policy ID to Exclude | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_DEFINED |
4 - 1.0
scpcli iam group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--types <value>]
[--ids <value>]
[--has_member <value>]
[--has_role <value>]
[--is_completed <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_user_id <value>]
[--exclude_policy_id <value>]
Description
List Groups
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 | Group Name | TestGroup |
| types optional | string | Group Types | USER_DEFINED,DEFAULT |
| ids optional | string | Group ID List | 629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765 |
| has_member optional | string | Group Member Existence | false |
| has_role optional | string | Group Role Existence | false |
| is_completed optional | string | Group Completion Status | false |
| creator_name optional | string | Creator Last Name, First Name | Kim Samsung |
| creator_email optional | string | Creator Email | samsung.kim@samsung.com |
| modifier_name optional | string | Modifier Last Name, First Name | Kim Samsung |
| modifier_email optional | string | Modifier Email | samsung.kim@samsung.com |
| exclude_user_id optional | string | User ID to Exclude | f39c460fade34fecb05ede8f904b24b7 |
| exclude_policy_id optional | string | Policy ID to Exclude | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_DEFINED |