Create an access group

POST /v2/groups

Create a new access group to assign multiple users and service ids to multiple policies. The group will be created in the account specified by the `account_id` parameter. The group name is a required field, but a description is optional. Because the group's name does not have to be unique, it is possible to create multiple groups with the same name.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.groups.create

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group.create

Request

Request Body

CreateGroupRequest

The access group to create.

name

Required *

string

Give the access group a unique name that doesn't conflict with an existing access group in the account. This field is case-insensitive and has a limit of 100 characters.

description

string

Assign an optional description for the access group. This field has a limit of 250 characters.

Path Parameters

Query Parameters

account_id

Required *

string

Account ID of the API keys(s) to query. If a service IAM ID is specified in iam_id then account_id must match the account of the IAM ID. If a user IAM ID is specified in iam_id then then account_id must match the account of the Authorization token.

Response

201 - Group Created.

id

string

The group's access group ID.

name

string

The group's name.

description

string

The group's description - if defined.

account_id

string

The account id where the group was created.

created_at

string

The timestamp of when the group was created.

created_by_id

string

The `iam_id` of the entity that created the group.

last_modified_at

string

The timestamp of when the group was last edited.

last_modified_by_id

string

The `iam_id` of the entity that last modified the group name or description.

href

string

A url to the given group resource.

is_federated

boolean

This is set to true if rules exist for the group.

crn

string

CRN of the access group

400 - Bad Request

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

401 -

403 -

409 - Group Name Conflicted.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

500 -

503 -

List access groups

GET /v2/groups

This API lists access groups within an account. Parameters for pagination and sorting can be used to filter the results. The `account_id` query parameter determines which account to retrieve groups from. Only the groups you have access to are returned (either because of a policy on a specific group or account level access (admin, editor, or viewer)). There may be more groups in the account that aren't shown if you lack the aforementioned permissions.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.groups.list

Auditing

Calling this method generates the following auditing event.

  • iam-groups.groups.list

Request

Path Parameters

Query Parameters

account_id

Required *

string

Account ID of the API keys(s) to query. If a service IAM ID is specified in iam_id then account_id must match the account of the IAM ID. If a user IAM ID is specified in iam_id then then account_id must match the account of the Authorization token.

iam_id

string

Return groups for member ID (IBMid, service ID or trusted profile ID).

string

Use search to filter access groups list by id, name or description.

  • `search=id:<ACCESS_GROUP_ID>` - To list access groups by id
  • `search=name:<ACCESS_GROUP_NAME>` - To list access groups by name
  • `search=description:<ACCESS_GROUP_DESC>` - To list access groups by description

membership_type

string

Membership type need to be specified along with iam_id and must be either `static`, `dynamic` or `all`. If membership type is `static`, members explicitly added to the group will be shown. If membership type is `dynamic`, members accessing the access group at the moment via dynamic rules will be shown. If membership type is `all`, both static and dynamic members will be shown.

limit

integer

Return up to this limit of results where limit is between 0 and 100.

offset

integer

The offset of the first result item to be returned.

sort

string

Sort the results by id, name, description, or is_federated flag.

show_federated

boolean

If show_federated is true, each group listed will return an is_federated value that is set to true if rules exist for the group.

hide_public_access

boolean

If hide_public_access is true, do not include the Public Access Group in the results.

show_crn

boolean

If show_crn is true, group CRN will be included in the response.

Response

200 - Success.

limit

integer

Limit on how many items can be returned.

offset

integer

The offset of the first item returned in the result set.

total_count

integer

The total number of items that match the query.

first

HrefStruct

A link object.

previous

HrefStruct

A link object.

next

HrefStruct

A link object.

last

HrefStruct

A link object.

groups

array

An array of access groups.

401 -

403 -

500 -

503 -

Get an access group

GET /v2/groups/{access_group_id}

Retrieve an access group by its `access_group_id`. Only the groups data is returned (group name, description, account_id, ...), not membership or rule information. A revision number is returned in the `ETag` header, which is needed when updating the access group.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.groups.read

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group.read

Request

Path Parameters

Query Parameters

show_federated

boolean

If show_federated is true, the group will return an is_federated value that is set to true if rules exist for the group.

show_crn

boolean

If show_crn is true, group CRN will be included in the response.

Response

200 - Get Successful.

id

string

The group's access group ID.

name

string

The group's name.

description

string

The group's description - if defined.

account_id

string

The account id where the group was created.

created_at

string

The timestamp of when the group was created.

created_by_id

string

The `iam_id` of the entity that created the group.

last_modified_at

string

The timestamp of when the group was last edited.

last_modified_by_id

string

The `iam_id` of the entity that last modified the group name or description.

href

string

A url to the given group resource.

is_federated

boolean

This is set to true if rules exist for the group.

crn

string

CRN of the access group

401 -

403 -

404 -

500 -

503 -

Update an access group

PATCH /v2/groups/{access_group_id}

Update the group name or description of an existing access group using this API. An `If-Match` header must be populated with the group's most recent revision number (which can be acquired in the `Get an access group` API).

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.groups.update

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group.update

Request

Request Body

UpdateGroupRequest

The access group to update.

name

string

Give the access group a unique name that doesn't conflict with an existing access group in the account. This field is case-insensitive and has a limit of 100 characters.

description

string

Assign an optional description for the access group. This field has a limit of 250 characters.

Path Parameters

Query Parameters

Response

200 - Group Updated.

id

string

The group's access group ID.

name

string

The group's name.

description

string

The group's description - if defined.

account_id

string

The account id where the group was created.

created_at

string

The timestamp of when the group was created.

created_by_id

string

The `iam_id` of the entity that created the group.

last_modified_at

string

The timestamp of when the group was last edited.

last_modified_by_id

string

The `iam_id` of the entity that last modified the group name or description.

href

string

A url to the given group resource.

is_federated

boolean

This is set to true if rules exist for the group.

crn

string

CRN of the access group

400 - Bad Request.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

401 -

403 -

404 -

405 - Method Not Allowed.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

409 - Group Name Conflicted.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

412 - Precondition Failed.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

500 -

503 -

Delete an access group

DELETE /v2/groups/{access_group_id}

This API is used for deleting an access group. If the access group has no members or rules associated with it, the group and its policies will be deleted. However, if rules or members do exist, set the `force` parameter to true to delete the group as well as its associated members, rules, and policies.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.groups.delete

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group.delete

Request

Path Parameters

Query Parameters

force

boolean

If force is true, delete the group as well as its associated members and rules.

Response

204 - Delete Successful.

401 -

403 -

404 -

405 - Method Not Allowed.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

409 - Group Not Empty.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

500 -

503 -

Add members to an access group

PUT /v2/groups/{access_group_id}/members

Use this API to add users (`IBMid-...`), service IDs (`iam-ServiceId-...`) or trusted profiles (`iam-Profile-...`) to an access group. Any member added gains access to resources defined in the group's policies. To revoke a given members's access, simply remove them from the group. There is no limit to the number of members one group can have, but each `iam_id` can only be added to 50 groups. Additionally, this API request payload can add up to 50 members per call.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.members.add

Auditing

Calling this method generates the following auditing event.

  • iam-groups.member.add

Request

Request Body

AddGroupMembersRequest

List of members to add to the group. This field has a limit of 50 members.

members

array

An array of member objects to add to an access group.

Path Parameters

Query Parameters

Response

207 - There is a multiple status response. Please check the response body.

members

array

The members added to an access group.

400 - Bad Input (Including duplicate members in request).

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

401 -

403 -

404 - Not Found.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

405 - Method Not Allowed.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

500 -

503 -

List access group members

GET /v2/groups/{access_group_id}/members

List all members of a given group using this API. Parameters for pagination and sorting can be used to filter the results. The most useful query parameter may be the `verbose` flag. If `verbose=true`, user, service ID and trusted profile names will be retrieved for each `iam_id`. If performance is a concern, leave the `verbose` parameter off so that name information does not get retrieved.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.members.list

Auditing

Calling this method generates the following auditing event.

  • iam-groups.members.list

Request

Path Parameters

Query Parameters

membership_type

string

Filters members by membership type. Filter by `static`, `dynamic` or `all`. `static` lists the members explicitly added to the access group, and `dynamic` lists the members that are part of the access group at that time via dynamic rules. `all` lists both static and dynamic members.

limit

integer

Return up to this limit of results where limit is between 0 and 100.

offset

integer

The offset of the first result item to be returned.

type

string

Filter the results by member type.

verbose

boolean

Return user's email and name for each user ID or the name for each service ID or trusted profile.

sort

string

If verbose is true, sort the results by id, name, or email.

search

string

Use search to filter the members list by iam_id, name, or email. Accepts a comma-separated list of key:value pairs. Multiple keys are combined with OR logic.

  • `search=iam_id:<VALUE>` - Filter by IAM ID (always available, verbose not required)
  • `search=name:<VALUE>` - Filter by display name (requires verbose=true)
  • `search=email:<VALUE>` - Filter by email address (requires verbose=true)

Response

200 - Success.

limit

integer

Limit on how many items can be returned.

offset

integer

The offset of the first item returned in the result set.

total_count

integer

The total number of items that match the query.

first

HrefStruct

A link object.

previous

HrefStruct

A link object.

next

HrefStruct

A link object.

last

HrefStruct

A link object.

members

array

The members of an access group.

401 -

403 -

404 -

500 -

503 -

Check membership in an access group

HEAD /v2/groups/{access_group_id}/members/{iam_id}

This HEAD operation determines if a given `iam_id` is present in a group either explicitly or via dynamic rules. No response body is returned with this request. If the membership exists, a `204 - No Content` status code is returned. If the membership or the group does not exist, a `404 - Not Found` status code is returned.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.members.read

Auditing

Calling this method generates the following auditing event.

  • iam-groups.member.read

Request

Path Parameters

Query Parameters

Response

204 - Membership exists.

401 -

403 -

404 - Membership not found.

500 -

503 -

Delete member from an access group

DELETE /v2/groups/{access_group_id}/members/{iam_id}

Remove one member from a group using this API. If the operation is successful, only a `204 - No Content` response with no body is returned. However, if any error occurs, the standard error format will be returned. Dynamic member cannot be deleted using this API. Dynamic rules needs to be adjusted to delete dynamic members.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.members.delete

Auditing

Calling this method generates the following auditing event.

  • iam-groups.member.delete

Request

Path Parameters

Query Parameters

Response

204 - Membership deleted.

401 -

403 -

404 - Membership not found.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

405 - Method Not Allowed.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

500 -

503 -

Delete members from an access group

POST /v2/groups/{access_group_id}/members/delete

Remove multiple members from a group using this API. On a successful call, this API will always return 207. It is the caller's responsibility to iterate across the body to determine successful deletion of each member. This API request payload can delete up to 50 members per call. This API doesnt delete dynamic members accessing the access group via dynamic rules.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.members.delete

Auditing

Calling this method generates the following auditing event.

  • iam-groups.member.delete

Request

Request Body

DeleteGroupBulkMembersRequest

members

array

The `iam_id`s to remove from the access group. This field has a limit of 50 `iam_id`s.

Path Parameters

Query Parameters

Response

207 - There is a multiple status response. Please check the response body.

access_group_id

string

The access group id.

members

array

The `iam_id`s removed from the access group.

400 - Bad Input (Including duplicate members in request).

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

401 -

403 -

500 -

503 -

Delete member from all access groups

DELETE /v2/groups/_allgroups/members/{iam_id}

This API removes a given member from every group they are a member of within the specified account. By using one operation, you can revoke one member's access to all access groups in the account. If a partial failure occurs on deletion, the response will be shown in the body.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.members.delete

Auditing

Calling this method generates the following auditing event.

  • iam-groups.member.delete

Request

Path Parameters

iam_id

Required *

string

The IAM identifier.

Query Parameters

account_id

Required *

string

Account ID of the API keys(s) to query. If a service IAM ID is specified in iam_id then account_id must match the account of the IAM ID. If a user IAM ID is specified in iam_id then then account_id must match the account of the Authorization token.

Response

207 - There is a multiple status response. Please check the response body.

iam_id

string

The `iam_id` of the member to removed from groups.

groups

array

The groups the member was removed from.

401 -

403 -

404 -

500 -

503 -

Add member to multiple access groups

PUT /v2/groups/_allgroups/members/{iam_id}

This API will add a member to multiple access groups in an account. The limit of how many groups that can be in the request is 50. The response is a list of results that show if adding the member to each group was successful or not.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.members.add

Auditing

Calling this method generates the following auditing event.

  • iam-groups.member.add

Request

Request Body

AddMembershipMultipleGroupsRequest

List of groups in the account the member should be added to.

type

string

The type of the member, must be either "user", "service" or "profile".

groups

array

The ids of the access groups a given member is to be added to.

Path Parameters

iam_id

Required *

string

The IAM identifier.

Query Parameters

account_id

Required *

string

Account ID of the API keys(s) to query. If a service IAM ID is specified in iam_id then account_id must match the account of the IAM ID. If a user IAM ID is specified in iam_id then then account_id must match the account of the Authorization token.

Response

207 - There is a multiple status response. Please check the response body.

iam_id

string

The iam_id of a member.

groups

array

The list of access groups a member was added to.

400 - Bad Input (Including duplicate groups in request).

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

401 -

500 -

503 -

Create rule for an access group

POST /v2/groups/{access_group_id}/rules

Rules can be used to dynamically add users to an access group. If a user's SAML assertions match the rule's conditions during login, the user will be dynamically added to the group. The duration of the user's access to the group is determined by the `expiration` field. After access expires, the user will need to log in again to regain access. Note that the condition's value field must be a stringified JSON value. Consult this documentation for further explanation of dynamic rules.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.rules.create

Auditing

Calling this method generates the following auditing event.

  • iam-groups.rule.create

Request

Request Body

Path Parameters

Query Parameters

Response

201 - Rule Created.

id

string

The rule id.

name

string

The name of the rule.

expiration

integer

Session duration in hours. Access group membership is revoked after this time period expires. Users must log back in to refresh their access group membership. Must be ≥ 1.

realm_name

string

The URL of the identity provider.

access_group_id

string

The group id that the dynamic rule is assigned to.

account_id

string

The account id that the group is in.

conditions

array

A list of conditions that identities must satisfy to gain access group membership.

created_at

string

The timestamp for when the rule was created.

created_by_id

string

The `iam_id` of the entity that created the dynamic rule.

last_modified_at

string

The timestamp for when the dynamic rule was last edited.

last_modified_by_id

string

The IAM id that last modified the rule.

400 - Bad Request.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

401 -

403 -

404 -

405 - Method Not Allowed.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

500 -

503 -

List access group rules

GET /v2/groups/{access_group_id}/rules

This API lists all rules in a given access group. Because only a few rules are created on each group, there is no pagination or sorting support on this API.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.rules.list

Auditing

Calling this method generates the following auditing event.

  • iam-groups.rules.list

Request

Path Parameters

Query Parameters

Response

200 - List all rules in the given access group.

rules

array

A list of dynamic rules.

401 -

403 -

404 -

500 -

503 -

Get an access group rule

GET /v2/groups/{access_group_id}/rules/{rule_id}

Retrieve a rule from an access group. A revision number is returned in the `ETag` header, which is needed when updating the rule.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.rules.read

Auditing

Calling this method generates the following auditing event.

  • iam-groups.rule.read

Request

Path Parameters

Query Parameters

Response

200 - Get Rule Successful.

id

string

The rule id.

name

string

The name of the rule.

expiration

integer

Session duration in hours. Access group membership is revoked after this time period expires. Users must log back in to refresh their access group membership. Must be ≥ 1.

realm_name

string

The URL of the identity provider.

access_group_id

string

The group id that the dynamic rule is assigned to.

account_id

string

The account id that the group is in.

conditions

array

A list of conditions that identities must satisfy to gain access group membership.

created_at

string

The timestamp for when the rule was created.

created_by_id

string

The `iam_id` of the entity that created the dynamic rule.

last_modified_at

string

The timestamp for when the dynamic rule was last edited.

last_modified_by_id

string

The IAM id that last modified the rule.

400 - Bad Request.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

401 -

403 -

404 -

405 - Method Not Allowed.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

500 -

503 -

Replace an access group rule

PUT /v2/groups/{access_group_id}/rules/{rule_id}

Update the body of an existing rule using this API. An `If-Match` header must be populated with the rule's most recent revision number (which can be acquired in the `Get an access group rule` API).

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.rules.update

Auditing

Calling this method generates the following auditing event.

  • iam-groups.rule.update

Request

Request Body

Path Parameters

Query Parameters

Response

200 - Rule Updated.

id

string

The rule id.

name

string

The name of the rule.

expiration

integer

Session duration in hours. Access group membership is revoked after this time period expires. Users must log back in to refresh their access group membership. Must be ≥ 1.

realm_name

string

The URL of the identity provider.

access_group_id

string

The group id that the dynamic rule is assigned to.

account_id

string

The account id that the group is in.

conditions

array

A list of conditions that identities must satisfy to gain access group membership.

created_at

string

The timestamp for when the rule was created.

created_by_id

string

The `iam_id` of the entity that created the dynamic rule.

last_modified_at

string

The timestamp for when the dynamic rule was last edited.

last_modified_by_id

string

The IAM id that last modified the rule.

400 - Bad Request.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

401 -

403 -

404 -

405 - Method Not Allowed.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

412 - Precondition Failed.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

500 -

503 -

Delete an access group rule

DELETE /v2/groups/{access_group_id}/rules/{rule_id}

Remove one rule from a group using this API. If the operation is successful, only a `204 - No Content` response with no body is returned. However, if any error occurs, the standard error format will be returned.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.rules.delete

Auditing

Calling this method generates the following auditing event.

  • iam-groups.rule.delete

Request

Path Parameters

Query Parameters

Response

204 - Delete Successful.

401 -

403 -

404 -

405 - Method Not Allowed.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

500 -

503 -

Get account settings

GET /v2/groups/settings

Retrieve the access groups settings for a specific account.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.account-settings.read

Auditing

Calling this method generates the following auditing event.

  • iam-groups.account-settings.read

Request

Path Parameters

Query Parameters

account_id

Required *

string

Account ID of the API keys(s) to query. If a service IAM ID is specified in iam_id then account_id must match the account of the IAM ID. If a user IAM ID is specified in iam_id then then account_id must match the account of the Authorization token.

Response

200 - Get Successful.

account_id

string

The account id of the settings being shown.

last_modified_at

string

The timestamp the settings were last edited at.

last_modified_by_id

string

The `iam_id` of the entity that last modified the settings.

public_access_enabled

boolean

This flag controls the public access feature within the account. It is set to true by default. Note: When this flag is set to false, all policies within the account attached to the Public Access group will be deleted.

400 - Invalid Account ID.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

401 -

403 -

500 -

503 -

Update account settings

PATCH /v2/groups/settings

Update the access groups settings for a specific account. Note: When the `public_access_enabled` setting is set to false, all policies within the account attached to the Public Access group will be deleted. Only set `public_access_enabled` to false if you are sure that you want those policies to be removed.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.account-settings.update

Auditing

Calling this method generates the following auditing event.

  • iam-groups.account-settings.update

Request

Request Body

AccountSettingsRequest

The account settings to update.

public_access_enabled

boolean

This flag controls the public access feature within the account. It is set to true by default. Note: When this flag is set to false, all policies within the account attached to the Public Access group will be deleted.

Path Parameters

Query Parameters

account_id

Required *

string

Account ID of the API keys(s) to query. If a service IAM ID is specified in iam_id then account_id must match the account of the IAM ID. If a user IAM ID is specified in iam_id then then account_id must match the account of the Authorization token.

Response

200 - Settings Updated.

account_id

string

The account id of the settings being shown.

last_modified_at

string

The timestamp the settings were last edited at.

last_modified_by_id

string

The `iam_id` of the entity that last modified the settings.

public_access_enabled

boolean

This flag controls the public access feature within the account. It is set to true by default. Note: When this flag is set to false, all policies within the account attached to the Public Access group will be deleted.

400 - Bad Request.

status_code

integer

The HTTP status code of the response.

trace

string

The request's Transaction-Id.

errors

array

List of errors encountered in the service request.

401 -

403 -

500 -

503 -

Create template

POST /v1/group_templates

Create an access group template. Make sure that the template is generic enough to apply to multiple different child accounts. Before you can assign an access group template to child accounts, you must commit it so that no further changes can be made to the version.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.group-template.create

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group-template.create

Request

Request Body

TemplateRequest

name

Required *

string

Give the access group template a unique name that doesn't conflict with an existing access group templates in the account.

description

string

Assign an optional description for the access group template.

account_id

Required *

string

Enterprise account id in which the template will be created.

commit

boolean

A boolean parameter that specifies whether to commit the access group template at the time of creation. Templates must be committed before they can be assigned to child accounts.

group

AccessGroupRequest

Access Group Component

name

Required *

string

Give the access group a unique name that doesn't conflict with other templates access group name in the given account. This is shown in child accounts.

description

string

Access group description. This is shown in child accounts.

members

object

Array of enterprise users to add to the template. All enterprise users that you add to the template must be invited to the child accounts where the template is assigned.

assertions

object

Assertions Input Component

action_controls

object

Access group action controls component

policy_template_references

array

Existing policy templates that you can reference to assign access in the Access group input component

Path Parameters

Query Parameters

Response

201 - Successful response

id

string

The ID of the access group template

name

string

The name of the access group template

description

string

The description of the access group template

account_id

string

The ID of the account to which the access group template is assigned

version

string

The version of the access group template

committed

boolean

A boolean indicating whether the access group template is committed. You must commit a template before you can assign it to child accounts.

group

AccessGroupResponse

Access Group Component

policy_template_references

array

References to policy templates assigned to the access group template

href

string

The URL of the access group template resource

created_at

string

The date and time when the access group template was created

created_by_id

string

The ID of the user who created the access group template

last_modified_at

string

The date and time when the access group template was last modified

last_modified_by_id

string

The ID of the user who last modified the access group template

400 - Bad request

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

401 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

403 - Access denied

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

409 - Template Conflict Error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

429 - Templates per account limit reached

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

500 - Internal server error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

List templates

GET /v1/group_templates

List the access group templates in an enterprise account.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.group-template.read

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group-template.read

Request

Path Parameters

Query Parameters

account_id

Required *

string

Enterprise account ID

limit

integer

Return up to this limit of results where limit is between 0 and 100.

offset

integer

The offset of the first result item to be returned.

verbose

boolean

If `verbose=true`, IAM resource details are returned. If performance is a concern, leave the `verbose` parameter off so that details are not retrieved.

Response

200 - Successful response

limit

integer

The maximum number of IAM resources to return

offset

integer

The offset of the first IAM resource in the list

total_count

integer

The total number of IAM resources in the list

first

HrefStruct

A link object.

previous

HrefStruct

A link object.

next

HrefStruct

A link object.

last

HrefStruct

A link object.

group_templates

array

A list of access group templates

401 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

403 - Access denied

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

500 - Internal server error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

Create template version

POST /v1/group_templates/{template_id}/versions

Create a new version of an access group template.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.group-template.create

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group-template.create

Request

Request Body

TemplateVersionRequest

name

string

This is an optional field. If the field is included it will change the name value for all existing versions of the template..

description

string

Assign an optional description for the access group template version.

commit

boolean

A boolean parameter that specifies whether to commit the access group template at the time of updation/Create Template Version. Templates must be committed before they can be assigned to child accounts.

group

AccessGroupRequest

Access Group Component

name

Required *

string

Give the access group a unique name that doesn't conflict with other templates access group name in the given account. This is shown in child accounts.

description

string

Access group description. This is shown in child accounts.

members

object

Array of enterprise users to add to the template. All enterprise users that you add to the template must be invited to the child accounts where the template is assigned.

assertions

object

Assertions Input Component

action_controls

object

Access group action controls component

policy_template_references

array

The policy templates associated with the template version.

Path Parameters

template_id

Required *

string

ID of the template that you want to create a new version of

Query Parameters

Response

201 - Successful response

id

string

The ID of the access group template

name

string

The name of the access group template

description

string

The description of the access group template

account_id

string

The ID of the account to which the access group template is assigned

version

string

The version of the access group template

committed

boolean

A boolean indicating whether the access group template is committed. You must commit a template before you can assign it to child accounts.

group

AccessGroupResponse

Access Group Component

policy_template_references

array

References to policy templates assigned to the access group template

href

string

The URL of the access group template resource

created_at

string

The date and time when the access group template was created

created_by_id

string

The ID of the user who created the access group template

last_modified_at

string

The date and time when the access group template was last modified

last_modified_by_id

string

The ID of the user who last modified the access group template

401 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

403 - Template version limit reached

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

500 - Internal server error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

List template versions

GET /v1/group_templates/{template_id}/versions

List all the versions of an access group template.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.group-template.read

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group-template.read

Request

Path Parameters

template_id

Required *

string

ID of the template that you want to list all versions of

Query Parameters

limit

integer

Return up to this limit of results where limit is between 0 and 100.

offset

integer

The offset of the first result item to be returned.

Response

200 - Successful response

limit

integer

The maximum number of IAM resources to return

offset

integer

The offset of the first IAM resource in the list

total_count

integer

The total number of IAM resources in the list

first

HrefStruct

A link object.

previous

HrefStruct

A link object.

next

HrefStruct

A link object.

last

HrefStruct

A link object.

group_template_versions

array

A list of access group template versions

400 - Invalid payload

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

401 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

403 - Access denied

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

404 - Template not found

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

500 - Internal server error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

Get template version

GET /v1/group_templates/{template_id}/versions/{version_num}

Get a specific version of a template.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.group-template.read

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group-template.read

Request

Path Parameters

template_id

Required *

string

ID of the template to get a specific version of

version_num

Required *

string

Version number

Query Parameters

verbose

boolean

If `verbose=true`, IAM resource details are returned. If performance is a concern, leave the `verbose` parameter off so that details are not retrieved.

Response

200 - Successful response

id

string

The ID of the access group template

name

string

The name of the access group template

description

string

The description of the access group template

account_id

string

The ID of the account to which the access group template is assigned

version

string

The version of the access group template

committed

boolean

A boolean indicating whether the access group template is committed. You must commit a template before you can assign it to child accounts.

group

AccessGroupResponse

Access Group Component

policy_template_references

array

References to policy templates assigned to the access group template

href

string

The URL of the access group template resource

created_at

string

The date and time when the access group template was created

created_by_id

string

The ID of the user who created the access group template

last_modified_at

string

The date and time when the access group template was last modified

last_modified_by_id

string

The ID of the user who last modified the access group template

401 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

403 - Access denied

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

404 - Not Found

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

500 - Internal server error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

Update template version

PUT /v1/group_templates/{template_id}/versions/{version_num}

Update a template version. You can only update a version that isn't committed. Create a new version if you need to update a committed version.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.group-template.update

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group-template.update

Request

Request Body

TemplateVersionRequest

name

string

This is an optional field. If the field is included it will change the name value for all existing versions of the template..

description

string

Assign an optional description for the access group template version.

commit

boolean

A boolean parameter that specifies whether to commit the access group template at the time of updation/Create Template Version. Templates must be committed before they can be assigned to child accounts.

group

AccessGroupRequest

Access Group Component

name

Required *

string

Give the access group a unique name that doesn't conflict with other templates access group name in the given account. This is shown in child accounts.

description

string

Access group description. This is shown in child accounts.

members

object

Array of enterprise users to add to the template. All enterprise users that you add to the template must be invited to the child accounts where the template is assigned.

assertions

object

Assertions Input Component

action_controls

object

Access group action controls component

policy_template_references

array

The policy templates associated with the template version.

Path Parameters

template_id

Required *

string

ID of the template

version_num

Required *

string

Version number of the template

Query Parameters

Response

201 - Successful response

id

string

The ID of the access group template

name

string

The name of the access group template

description

string

The description of the access group template

account_id

string

The ID of the account to which the access group template is assigned

version

string

The version of the access group template

committed

boolean

A boolean indicating whether the access group template is committed. You must commit a template before you can assign it to child accounts.

group

AccessGroupResponse

Access Group Component

policy_template_references

array

References to policy templates assigned to the access group template

href

string

The URL of the access group template resource

created_at

string

The date and time when the access group template was created

created_by_id

string

The ID of the user who created the access group template

last_modified_at

string

The date and time when the access group template was last modified

last_modified_by_id

string

The ID of the user who last modified the access group template

400 - Bad request

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

401 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

403 - Access denied

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

404 - Template not found

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

409 - Status Conflict

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

412 - Pre-condition check Fail

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

500 - Internal server error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

Delete template version

DELETE /v1/group_templates/{template_id}/versions/{version_num}

Delete a template version. You must remove all assignments for a template version before you can delete it.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.group-template.delete

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group-template.delete

Request

Path Parameters

template_id

Required *

string

ID of the template to delete

version_num

Required *

string

version number in path

Query Parameters

Response

204 - Successful response

401 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

403 - Access denied

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

404 - Not Found

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

500 - Internal server error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

Commit a template

POST /v1/group_templates/{template_id}/versions/{version_num}/commit

Commit a template version. You must do this before you can assign a template version to child accounts. After you commit the template version, you can't make any further changes.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.group-template.update

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group-template.update

Request

Path Parameters

template_id

Required *

string

ID of the template to commit

version_num

Required *

string

version number in path

Query Parameters

Response

204 - Successful response

400 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

401 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

403 - Access denied

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

404 - Not Found

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

412 - Pre-condition Fail

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

500 - Internal server error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

Get latest template version

GET /v1/group_templates/{template_id}

Get the latest version of a template.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.group-template.read

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group-template.read

Request

Path Parameters

template_id

Required *

string

ID of the template to get a specific version of

Query Parameters

verbose

boolean

If `verbose=true`, IAM resource details are returned. If performance is a concern, leave the `verbose` parameter off so that details are not retrieved.

Response

200 - Successful response

id

string

The ID of the access group template

name

string

The name of the access group template

description

string

The description of the access group template

account_id

string

The ID of the account to which the access group template is assigned

version

string

The version of the access group template

committed

boolean

A boolean indicating whether the access group template is committed. You must commit a template before you can assign it to child accounts.

group

AccessGroupResponse

Access Group Component

policy_template_references

array

References to policy templates assigned to the access group template

href

string

The URL of the access group template resource

created_at

string

The date and time when the access group template was created

created_by_id

string

The ID of the user who created the access group template

last_modified_at

string

The date and time when the access group template was last modified

last_modified_by_id

string

The ID of the user who last modified the access group template

401 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

403 - Access denied

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

404 - Template Not Found

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

500 - Internal server error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

Delete template

DELETE /v1/group_templates/{template_id}

Endpoint to delete a template. All access assigned by that template is deleted from all of the accounts where the template was assigned.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.group-template.delete

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group-template.delete

Request

Response

204 - Successful response

401 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

403 - Forbidden

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

404 - Template Not Found

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

500 - Internal server error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

Create assignment

POST /v1/group_assignments

Assign a template version to accounts that have enabled enterprise-managed IAM. You can specify individual accounts, or an entire account group to assign the template to all current and future child accounts of that account group.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.group-assignment.create

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group-assignment.create

Request

Request Body

TemplateAssignmentRequest

template_id

Required *

string

The unique identifier of the template to be assigned.

template_version

Required *

string

The version number of the template to be assigned.

target_type

Required *

string

The type of the entity to which the template should be assigned, e.g. 'Account', 'AccountGroup', etc.

target

Required *

string

The unique identifier of the entity to which the template should be assigned.

Path Parameters

Query Parameters

Response

202 - Successful response

id

string

The ID of the assignment

account_id

string

The ID of the account that the assignment belongs to

template_id

string

The ID of the template that the assignment is based on

template_version

string

The version of the template that the assignment is based on

target_type

string

The type of the entity that the assignment applies to

target

string

The ID of the entity that the assignment applies to

operation

string

The operation that the assignment applies to (e.g. 'assign', 'update', 'remove')

status

string

The status of the assignment (e.g. 'accepted', 'in_progress', 'succeeded', 'failed', 'superseded')

href

string

The URL of the assignment resource

created_at

string

The date and time when the assignment was created

created_by_id

string

The user or system that created the assignment

last_modified_at

string

The date and time when the assignment was last updated

last_modified_by_id

string

The user or system that last updated the assignment

400 - Bad request

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

401 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

403 - Forbidden

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

500 - Internal server error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

List assignments

GET /v1/group_assignments

List template assignments from an enterprise account.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.group-assignment.read

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group-assignment.read

Request

Path Parameters

Query Parameters

account_id

Required *

string

Enterprise account ID

template_id

string

Filter results by Template Id

template_version

string

Filter results by Template Version

target

string

Filter results by the assignment target

status

string

Filter results by the assignment status

limit

integer

Return up to this limit of results where limit is between 0 and 100.

offset

integer

The offset of the first result item to be returned.

Response

200 - Successful response

limit

integer

Maximum number of items returned in the response

offset

integer

Index of the first item returned in the response

total_count

integer

Total number of items matching the query

first

HrefStruct

A link object.

last

HrefStruct

A link object.

assignments

array

List of template assignments

400 - Invalid Account Id

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

401 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

403 - Access denied

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

500 - Internal server error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

Get assignment

GET /v1/group_assignments/{assignment_id}

Get a specific template assignment.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.group-assignment.read

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group-assignment.read

Request

Path Parameters

assignment_id

Required *

string

Assignment ID

Query Parameters

verbose

boolean

Returns resources access group template assigned, possible values `true` or `false`

Response

200 - Successful response

id

string

The ID of the assignment

account_id

string

The ID of the account that the assignment belongs to

template_id

string

The ID of the template that the assignment is based on

template_version

string

The version of the template that the assignment is based on

target_type

string

The type of the entity that the assignment applies to

target

string

The ID of the entity that the assignment applies to

operation

string

The operation that the assignment applies to (e.g. 'create', 'update', 'delete')

status

string

The status of the assignment (e.g. 'pending', 'success', 'failure')

resources

array

List of resources for the assignment

href

string

The URL of the assignment resource

created_at

string

The date and time when the assignment was created

created_by_id

string

The user or system that created the assignment

last_modified_at

string

The date and time when the assignment was last updated

last_modified_by_id

string

The user or system that last updated the assignment

400 - Bad request

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

401 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

403 - Access denied

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

404 - Not Found

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

500 - Internal server error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

Update Assignment

PATCH /v1/group_assignments/{assignment_id}

Endpoint to update template assignment

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.group-assignment.update

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group-assignment.update

Request

Request Body

UpdateTemplateAssignmentRequest

template_version

Required *

string

Template version which shall be applied to the assignment.

Path Parameters

assignment_id

Required *

string

ID of the Assignment Record

Query Parameters

Response

202 - Successful response

id

string

The ID of the assignment

account_id

string

The ID of the account that the assignment belongs to

template_id

string

The ID of the template that the assignment is based on

template_version

string

The version of the template that the assignment is based on

target_type

string

The type of the entity that the assignment applies to

target

string

The ID of the entity that the assignment applies to

operation

string

The operation that the assignment applies to (e.g. 'create', 'update', 'delete')

status

string

The status of the assignment (e.g. 'pending', 'success', 'failure')

resources

array

List of resources for the assignment

href

string

The URL of the assignment resource

created_at

string

The date and time when the assignment was created

created_by_id

string

The user or system that created the assignment

last_modified_at

string

The date and time when the assignment was last updated

last_modified_by_id

string

The user or system that last updated the assignment

400 - Bad request

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

401 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

403 - Forbidden

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

500 - Internal server error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

Delete assignment

DELETE /v1/group_assignments/{assignment_id}

Delete an access group template assignment.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

  • iam-groups.group-assignment.delete

Auditing

Calling this method generates the following auditing event.

  • iam-groups.group-assignment.delete

Request

Path Parameters

assignment_id

Required *

string

assignment id path parameter

Query Parameters

Response

202 - Successful response

400 - Invalid Assignment

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

401 - Unauthorized

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

403 - Access denied

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

404 - Not Found

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

409 - Template assignment in progress error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models

500 - Internal server error

status_code

integer

HTTP status code of the response

code

string

Error code for the response

message

string

Error message for the response

trace

string

Additional information about the error

errors

array

An array of error models