This is the multi-page printable view of this section. Click here to print.
SetGroup
1 - 1.3
scpcli iam-identity-center group set
--group_id <value>
--instance_id <value>
[--description <value>]
[--name <value>]
Description
set a specific group
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Group Description | Group for administrators |
| name optional | string | Group Name | Admin_Group |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
2 - 1.2
scpcli iam-identity-center group set
--group_id <value>
--instance_id <value>
[--description <value>]
[--name <value>]
Description
set a specific group
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Group Description | Group for administrators |
| name optional | string | Group Name | Admin_Group |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
3 - 1.1
scpcli iam-identity-center group set
--group_id <value>
--instance_id <value>
[--description <value>]
[--name <value>]
Description
set a specific group
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 |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Group Description | Group for administrators |
| name optional | string | Group Name | Admin_Group |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
4 - 1.0
scpcli iam-identity-center group set
--group_id <value>
--instance_id <value>
[--description <value>]
[--name <value>]
Description
set a specific group
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 |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Group Description | Group for administrators |
| name optional | string | Group Name | Admin_Group |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |