iamaccessgroupsv2

package
v0.69.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 18, 2024 License: Apache-2.0 Imports: 10 Imported by: 12

Documentation

Overview

Package iamaccessgroupsv2 : Operations and models for the IamAccessGroupsV2 service

Index

Constants

View Source 
const (
	CreateAssignmentOptionsTargetTypeAccountConst      = "Account"
	CreateAssignmentOptionsTargetTypeAccountgroupConst = "AccountGroup"
)

Constants associated with the CreateAssignmentOptions.TargetType property. The type of the entity to which the template should be assigned, e.g. 'Account', 'AccountGroup', etc.

View Source 
const (
	ListAssignmentsOptionsStatusAcceptedConst   = "accepted"
	ListAssignmentsOptionsStatusFailedConst     = "failed"
	ListAssignmentsOptionsStatusInProgressConst = "in_progress"
	ListAssignmentsOptionsStatusSucceededConst  = "succeeded"
)

Constants associated with the ListAssignmentsOptions.Status property. Filter results by the assignment status.

View Source 
const (
	RuleConditionsOperatorContainsConst            = "CONTAINS"
	RuleConditionsOperatorEqualsConst              = "EQUALS"
	RuleConditionsOperatorEqualsIgnoreCaseConst    = "EQUALS_IGNORE_CASE"
	RuleConditionsOperatorInConst                  = "IN"
	RuleConditionsOperatorNotEqualsConst           = "NOT_EQUALS"
	RuleConditionsOperatorNotEqualsIgnoreCaseConst = "NOT_EQUALS_IGNORE_CASE"
)

Constants associated with the RuleConditions.Operator property. The operation to perform on the claim.

View Source 
const (
	TemplateAssignmentResponseTargetTypeAccountConst      = "Account"
	TemplateAssignmentResponseTargetTypeAccountgroupConst = "AccountGroup"
)

Constants associated with the TemplateAssignmentResponse.TargetType property. The type of the entity that the assignment applies to.

View Source 
const (
	TemplateAssignmentResponseOperationAssignConst = "assign"
	TemplateAssignmentResponseOperationRemoveConst = "remove"
	TemplateAssignmentResponseOperationUpdateConst = "update"
)

Constants associated with the TemplateAssignmentResponse.Operation property. The operation that the assignment applies to (e.g. 'assign', 'update', 'remove').

View Source 
const (
	TemplateAssignmentResponseStatusAcceptedConst   = "accepted"
	TemplateAssignmentResponseStatusFailedConst     = "failed"
	TemplateAssignmentResponseStatusInProgressConst = "in_progress"
	TemplateAssignmentResponseStatusSucceededConst  = "succeeded"
	TemplateAssignmentResponseStatusSupersededConst = "superseded"
)

Constants associated with the TemplateAssignmentResponse.Status property. The status of the assignment (e.g. 'accepted', 'in_progress', 'succeeded', 'failed', 'superseded').

View Source 
const DefaultServiceName = "iam_access_groups"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://iam.cloud.ibm.com"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func GetServiceURLForRegion added in v0.17.2 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalAccessActionControls added in v0.44.0 

func UnmarshalAccessActionControls(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAccessActionControls unmarshals an instance of AccessActionControls from the specified map of raw messages.

func UnmarshalAccessGroupRequest added in v0.44.0 

func UnmarshalAccessGroupRequest(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAccessGroupRequest unmarshals an instance of AccessGroupRequest from the specified map of raw messages.

func UnmarshalAccessGroupResponse added in v0.44.0 

func UnmarshalAccessGroupResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAccessGroupResponse unmarshals an instance of AccessGroupResponse from the specified map of raw messages.

func UnmarshalAccountSettings 

func UnmarshalAccountSettings(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAccountSettings unmarshals an instance of AccountSettings from the specified map of raw messages.

func UnmarshalAddGroupMembersRequestMembersItem added in v0.3.0 

func UnmarshalAddGroupMembersRequestMembersItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAddGroupMembersRequestMembersItem unmarshals an instance of AddGroupMembersRequestMembersItem from the specified map of raw messages.

func UnmarshalAddGroupMembersResponse 

func UnmarshalAddGroupMembersResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAddGroupMembersResponse unmarshals an instance of AddGroupMembersResponse from the specified map of raw messages.

func UnmarshalAddGroupMembersResponseMembersItem 

func UnmarshalAddGroupMembersResponseMembersItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAddGroupMembersResponseMembersItem unmarshals an instance of AddGroupMembersResponseMembersItem from the specified map of raw messages.

func UnmarshalAddMembershipMultipleGroupsResponse 

func UnmarshalAddMembershipMultipleGroupsResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAddMembershipMultipleGroupsResponse unmarshals an instance of AddMembershipMultipleGroupsResponse from the specified map of raw messages.

func UnmarshalAddMembershipMultipleGroupsResponseGroupsItem 

func UnmarshalAddMembershipMultipleGroupsResponseGroupsItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAddMembershipMultipleGroupsResponseGroupsItem unmarshals an instance of AddMembershipMultipleGroupsResponseGroupsItem from the specified map of raw messages.

func UnmarshalAssertions added in v0.44.0 

func UnmarshalAssertions(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAssertions unmarshals an instance of Assertions from the specified map of raw messages.

func UnmarshalAssertionsActionControls added in v0.44.0 

func UnmarshalAssertionsActionControls(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAssertionsActionControls unmarshals an instance of AssertionsActionControls from the specified map of raw messages.

func UnmarshalAssertionsRule added in v0.44.0 

func UnmarshalAssertionsRule(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAssertionsRule unmarshals an instance of AssertionsRule from the specified map of raw messages.

func UnmarshalAssignmentResourceAccessGroup added in v0.44.0 

func UnmarshalAssignmentResourceAccessGroup(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAssignmentResourceAccessGroup unmarshals an instance of AssignmentResourceAccessGroup from the specified map of raw messages.

func UnmarshalAssignmentResourceEntry added in v0.44.0 

func UnmarshalAssignmentResourceEntry(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAssignmentResourceEntry unmarshals an instance of AssignmentResourceEntry from the specified map of raw messages.

func UnmarshalConditions added in v0.44.0 

func UnmarshalConditions(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConditions unmarshals an instance of Conditions from the specified map of raw messages.

func UnmarshalDeleteFromAllGroupsResponse 

func UnmarshalDeleteFromAllGroupsResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeleteFromAllGroupsResponse unmarshals an instance of DeleteFromAllGroupsResponse from the specified map of raw messages.

func UnmarshalDeleteFromAllGroupsResponseGroupsItem 

func UnmarshalDeleteFromAllGroupsResponseGroupsItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeleteFromAllGroupsResponseGroupsItem unmarshals an instance of DeleteFromAllGroupsResponseGroupsItem from the specified map of raw messages.

func UnmarshalDeleteGroupBulkMembersResponse 

func UnmarshalDeleteGroupBulkMembersResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeleteGroupBulkMembersResponse unmarshals an instance of DeleteGroupBulkMembersResponse from the specified map of raw messages.

func UnmarshalDeleteGroupBulkMembersResponseMembersItem 

func UnmarshalDeleteGroupBulkMembersResponseMembersItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeleteGroupBulkMembersResponseMembersItem unmarshals an instance of DeleteGroupBulkMembersResponseMembersItem from the specified map of raw messages.

func UnmarshalError 

func UnmarshalError(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalError unmarshals an instance of Error from the specified map of raw messages.

func UnmarshalGroup 

func UnmarshalGroup(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroup unmarshals an instance of Group from the specified map of raw messages.

func UnmarshalGroupActionControls added in v0.44.0 

func UnmarshalGroupActionControls(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupActionControls unmarshals an instance of GroupActionControls from the specified map of raw messages.

func UnmarshalGroupMembersList 

func UnmarshalGroupMembersList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupMembersList unmarshals an instance of GroupMembersList from the specified map of raw messages.

func UnmarshalGroupTemplate added in v0.44.0 

func UnmarshalGroupTemplate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupTemplate unmarshals an instance of GroupTemplate from the specified map of raw messages.

func UnmarshalGroupsList 

func UnmarshalGroupsList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupsList unmarshals an instance of GroupsList from the specified map of raw messages.

func UnmarshalHrefStruct 

func UnmarshalHrefStruct(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalHrefStruct unmarshals an instance of HrefStruct from the specified map of raw messages.

func UnmarshalListGroupMembersResponseMember 

func UnmarshalListGroupMembersResponseMember(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListGroupMembersResponseMember unmarshals an instance of ListGroupMembersResponseMember from the specified map of raw messages.

func UnmarshalListTemplateAssignmentResponse added in v0.44.0 

func UnmarshalListTemplateAssignmentResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListTemplateAssignmentResponse unmarshals an instance of ListTemplateAssignmentResponse from the specified map of raw messages.

func UnmarshalListTemplateVersionResponse added in v0.44.0 

func UnmarshalListTemplateVersionResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListTemplateVersionResponse unmarshals an instance of ListTemplateVersionResponse from the specified map of raw messages.

func UnmarshalListTemplateVersionsResponse added in v0.44.0 

func UnmarshalListTemplateVersionsResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListTemplateVersionsResponse unmarshals an instance of ListTemplateVersionsResponse from the specified map of raw messages.

func UnmarshalListTemplatesResponse added in v0.44.0 

func UnmarshalListTemplatesResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListTemplatesResponse unmarshals an instance of ListTemplatesResponse from the specified map of raw messages.

func UnmarshalMembers added in v0.44.0 

func UnmarshalMembers(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMembers unmarshals an instance of Members from the specified map of raw messages.

func UnmarshalMembersActionControls added in v0.44.0 

func UnmarshalMembersActionControls(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMembersActionControls unmarshals an instance of MembersActionControls from the specified map of raw messages.

func UnmarshalPolicyTemplates added in v0.44.0 

func UnmarshalPolicyTemplates(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPolicyTemplates unmarshals an instance of PolicyTemplates from the specified map of raw messages.

func UnmarshalResourceListWithTargetAccountID added in v0.44.0 

func UnmarshalResourceListWithTargetAccountID(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourceListWithTargetAccountID unmarshals an instance of ResourceListWithTargetAccountID from the specified map of raw messages.

func UnmarshalRule 

func UnmarshalRule(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRule unmarshals an instance of Rule from the specified map of raw messages.

func UnmarshalRuleActionControls added in v0.44.0 

func UnmarshalRuleActionControls(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleActionControls unmarshals an instance of RuleActionControls from the specified map of raw messages.

func UnmarshalRuleConditions 

func UnmarshalRuleConditions(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleConditions unmarshals an instance of RuleConditions from the specified map of raw messages.

func UnmarshalRulesList 

func UnmarshalRulesList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRulesList unmarshals an instance of RulesList from the specified map of raw messages.

func UnmarshalTemplateAssignmentResponse added in v0.44.0 

func UnmarshalTemplateAssignmentResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTemplateAssignmentResponse unmarshals an instance of TemplateAssignmentResponse from the specified map of raw messages.

func UnmarshalTemplateAssignmentVerboseResponse added in v0.44.0 

func UnmarshalTemplateAssignmentVerboseResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTemplateAssignmentVerboseResponse unmarshals an instance of TemplateAssignmentVerboseResponse from the specified map of raw messages.

func UnmarshalTemplateResponse added in v0.44.0 

func UnmarshalTemplateResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTemplateResponse unmarshals an instance of TemplateResponse from the specified map of raw messages.

func UnmarshalTemplateVersionResponse added in v0.44.0 

func UnmarshalTemplateVersionResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTemplateVersionResponse unmarshals an instance of TemplateVersionResponse from the specified map of raw messages.

Types

type AccessActionControls added in v0.44.0 

type AccessActionControls struct {
	// Action control for adding access policies to an enterprise-managed access group in a child account. If an access
	// group administrator in a child account adds a policy, they can always update or remove it. Note that if conflicts
	// arise between an update to this control in a new version and polices added to the access group by an administrator
	// in a child account, you must resolve those conflicts in the child account. This prevents breaking access in the
	// child account. For more information, see [Working with
	// versions](https://test.cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-working-with-versions#new-version-scenarios).
	Add *bool `json:"add,omitempty"`
}

AccessActionControls : Control whether or not access group administrators in child accounts can add access policies to the enterprise-managed access group in their account.

type AccessGroupMembersPager added in v0.29.1 

type AccessGroupMembersPager struct {
	// contains filtered or unexported fields
}

AccessGroupMembersPager can be used to simplify the use of the "ListAccessGroupMembers" method.

func (*AccessGroupMembersPager) GetAll added in v0.29.1 

func (pager *AccessGroupMembersPager) GetAll() (allItems []ListGroupMembersResponseMember, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*AccessGroupMembersPager) GetAllWithContext added in v0.29.1 

func (pager *AccessGroupMembersPager) GetAllWithContext(ctx context.Context) (allItems []ListGroupMembersResponseMember, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*AccessGroupMembersPager) GetNext added in v0.29.1 

func (pager *AccessGroupMembersPager) GetNext() (page []ListGroupMembersResponseMember, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*AccessGroupMembersPager) GetNextWithContext added in v0.29.1 

func (pager *AccessGroupMembersPager) GetNextWithContext(ctx context.Context) (page []ListGroupMembersResponseMember, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*AccessGroupMembersPager) HasNext added in v0.29.1 

func (pager *AccessGroupMembersPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type AccessGroupRequest added in v0.44.0 

type AccessGroupRequest struct {
	// 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.
	Name *string `json:"name" validate:"required"`

	// Access group description. This is shown in child accounts.
	Description *string `json:"description,omitempty"`

	// 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.
	Members *Members `json:"members,omitempty"`

	// Assertions Input Component.
	Assertions *Assertions `json:"assertions,omitempty"`

	// Access group action controls component.
	ActionControls *GroupActionControls `json:"action_controls,omitempty"`
}

AccessGroupRequest : Access Group Component.

type AccessGroupResponse added in v0.44.0 

type AccessGroupResponse struct {
	// 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.
	Name *string `json:"name" validate:"required"`

	// Access group description. This is shown in child accounts.
	Description *string `json:"description,omitempty"`

	// 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.
	Members *Members `json:"members,omitempty"`

	// Assertions Input Component.
	Assertions *Assertions `json:"assertions,omitempty"`

	// Access group action controls component.
	ActionControls *GroupActionControls `json:"action_controls,omitempty"`
}

AccessGroupResponse : Access Group Component.

type AccessGroupsPager added in v0.29.1 

type AccessGroupsPager struct {
	// contains filtered or unexported fields
}

AccessGroupsPager can be used to simplify the use of the "ListAccessGroups" method.

func (*AccessGroupsPager) GetAll added in v0.29.1 

func (pager *AccessGroupsPager) GetAll() (allItems []Group, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*AccessGroupsPager) GetAllWithContext added in v0.29.1 

func (pager *AccessGroupsPager) GetAllWithContext(ctx context.Context) (allItems []Group, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*AccessGroupsPager) GetNext added in v0.29.1 

func (pager *AccessGroupsPager) GetNext() (page []Group, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*AccessGroupsPager) GetNextWithContext added in v0.29.1 

func (pager *AccessGroupsPager) GetNextWithContext(ctx context.Context) (page []Group, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*AccessGroupsPager) HasNext added in v0.29.1 

func (pager *AccessGroupsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type AccountSettings 

type AccountSettings struct {
	// The account id of the settings being shown.
	AccountID *string `json:"account_id,omitempty"`

	// The timestamp the settings were last edited at.
	LastModifiedAt *strfmt.DateTime `json:"last_modified_at,omitempty"`

	// The `iam_id` of the entity that last modified the settings.
	LastModifiedByID *string `json:"last_modified_by_id,omitempty"`

	// 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.
	PublicAccessEnabled *bool `json:"public_access_enabled,omitempty"`
}

AccountSettings : The access groups settings for a specific account.

type AddAccessGroupRuleOptions 

type AddAccessGroupRuleOptions struct {
	// The access group identifier.
	AccessGroupID *string `json:"access_group_id" validate:"required,ne="`

	// 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.
	Expiration *int64 `json:"expiration" validate:"required"`

	// The URL of the identity provider (IdP).
	RealmName *string `json:"realm_name" validate:"required"`

	// A list of conditions that identities must satisfy to gain access group membership.
	Conditions []RuleConditions `json:"conditions" validate:"required"`

	// The name of the dynaimic rule.
	Name *string `json:"name,omitempty"`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

AddAccessGroupRuleOptions : The AddAccessGroupRule options.

func (*AddAccessGroupRuleOptions) SetAccessGroupID 

func (_options *AddAccessGroupRuleOptions) SetAccessGroupID(accessGroupID string) *AddAccessGroupRuleOptions

SetAccessGroupID : Allow user to set AccessGroupID

func (*AddAccessGroupRuleOptions) SetConditions 

func (_options *AddAccessGroupRuleOptions) SetConditions(conditions []RuleConditions) *AddAccessGroupRuleOptions

SetConditions : Allow user to set Conditions

func (*AddAccessGroupRuleOptions) SetExpiration 

func (_options *AddAccessGroupRuleOptions) SetExpiration(expiration int64) *AddAccessGroupRuleOptions

SetExpiration : Allow user to set Expiration

func (*AddAccessGroupRuleOptions) SetHeaders 

func (options *AddAccessGroupRuleOptions) SetHeaders(param map[string]string) *AddAccessGroupRuleOptions

SetHeaders : Allow user to set Headers

func (*AddAccessGroupRuleOptions) SetName 

func (_options *AddAccessGroupRuleOptions) SetName(name string) *AddAccessGroupRuleOptions

SetName : Allow user to set Name

func (*AddAccessGroupRuleOptions) SetRealmName 

func (_options *AddAccessGroupRuleOptions) SetRealmName(realmName string) *AddAccessGroupRuleOptions

SetRealmName : Allow user to set RealmName

func (*AddAccessGroupRuleOptions) SetTransactionID 

func (_options *AddAccessGroupRuleOptions) SetTransactionID(transactionID string) *AddAccessGroupRuleOptions

SetTransactionID : Allow user to set TransactionID

type AddGroupMembersRequestMembersItem 

type AddGroupMembersRequestMembersItem struct {
	// The IBMid, service ID or trusted profile ID of the member.
	IamID *string `json:"iam_id" validate:"required"`

	// The type of the member, must be either "user", "service" or "profile".
	Type *string `json:"type" validate:"required"`
}

AddGroupMembersRequestMembersItem : AddGroupMembersRequestMembersItem struct

type AddGroupMembersResponse 

type AddGroupMembersResponse struct {
	// The members added to an access group.
	Members []AddGroupMembersResponseMembersItem `json:"members,omitempty"`
}

AddGroupMembersResponse : The members added to an access group.

type AddGroupMembersResponseMembersItem 

type AddGroupMembersResponseMembersItem struct {
	// The IBMid or Service Id of the member.
	IamID *string `json:"iam_id,omitempty"`

	// The member type - either `user`, `service` or `profile`.
	Type *string `json:"type,omitempty"`

	// The timestamp of when the membership was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The `iam_id` of the entity that created the membership.
	CreatedByID *string `json:"created_by_id,omitempty"`

	// The outcome of the operation on this `iam_id`.
	StatusCode *int64 `json:"status_code,omitempty"`

	// A transaction-id that can be used for debugging purposes.
	Trace *string `json:"trace,omitempty"`

	// A list of errors that occurred when trying to add members to a group.
	Errors []Error `json:"errors,omitempty"`
}

AddGroupMembersResponseMembersItem : AddGroupMembersResponseMembersItem struct

type AddMemberToMultipleAccessGroupsOptions 

type AddMemberToMultipleAccessGroupsOptions struct {
	// 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.
	AccountID *string `json:"account_id" validate:"required"`

	// The IAM identifier.
	IamID *string `json:"iam_id" validate:"required,ne="`

	// The type of the member, must be either "user", "service" or "profile".
	Type *string `json:"type,omitempty"`

	// The ids of the access groups a given member is to be added to.
	Groups []string `json:"groups,omitempty"`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

AddMemberToMultipleAccessGroupsOptions : The AddMemberToMultipleAccessGroups options.

func (*AddMemberToMultipleAccessGroupsOptions) SetAccountID 

func (_options *AddMemberToMultipleAccessGroupsOptions) SetAccountID(accountID string) *AddMemberToMultipleAccessGroupsOptions

SetAccountID : Allow user to set AccountID

func (*AddMemberToMultipleAccessGroupsOptions) SetGroups 

func (_options *AddMemberToMultipleAccessGroupsOptions) SetGroups(groups []string) *AddMemberToMultipleAccessGroupsOptions

SetGroups : Allow user to set Groups

func (*AddMemberToMultipleAccessGroupsOptions) SetHeaders 

func (options *AddMemberToMultipleAccessGroupsOptions) SetHeaders(param map[string]string) *AddMemberToMultipleAccessGroupsOptions

SetHeaders : Allow user to set Headers

func (*AddMemberToMultipleAccessGroupsOptions) SetIamID 

func (_options *AddMemberToMultipleAccessGroupsOptions) SetIamID(iamID string) *AddMemberToMultipleAccessGroupsOptions

SetIamID : Allow user to set IamID

func (*AddMemberToMultipleAccessGroupsOptions) SetTransactionID 

func (_options *AddMemberToMultipleAccessGroupsOptions) SetTransactionID(transactionID string) *AddMemberToMultipleAccessGroupsOptions

SetTransactionID : Allow user to set TransactionID

func (*AddMemberToMultipleAccessGroupsOptions) SetType 

func (_options *AddMemberToMultipleAccessGroupsOptions) SetType(typeVar string) *AddMemberToMultipleAccessGroupsOptions

SetType : Allow user to set Type

type AddMembersToAccessGroupOptions 

type AddMembersToAccessGroupOptions struct {
	// The access group identifier.
	AccessGroupID *string `json:"access_group_id" validate:"required,ne="`

	// An array of member objects to add to an access group.
	Members []AddGroupMembersRequestMembersItem `json:"members,omitempty"`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

AddMembersToAccessGroupOptions : The AddMembersToAccessGroup options.

func (*AddMembersToAccessGroupOptions) SetAccessGroupID 

func (_options *AddMembersToAccessGroupOptions) SetAccessGroupID(accessGroupID string) *AddMembersToAccessGroupOptions

SetAccessGroupID : Allow user to set AccessGroupID

func (*AddMembersToAccessGroupOptions) SetHeaders 

func (options *AddMembersToAccessGroupOptions) SetHeaders(param map[string]string) *AddMembersToAccessGroupOptions

SetHeaders : Allow user to set Headers

func (*AddMembersToAccessGroupOptions) SetMembers 

func (_options *AddMembersToAccessGroupOptions) SetMembers(members []AddGroupMembersRequestMembersItem) *AddMembersToAccessGroupOptions

SetMembers : Allow user to set Members

func (*AddMembersToAccessGroupOptions) SetTransactionID 

func (_options *AddMembersToAccessGroupOptions) SetTransactionID(transactionID string) *AddMembersToAccessGroupOptions

SetTransactionID : Allow user to set TransactionID

type AddMembershipMultipleGroupsResponse 

type AddMembershipMultipleGroupsResponse struct {
	// The iam_id of a member.
	IamID *string `json:"iam_id,omitempty"`

	// The list of access groups a member was added to.
	Groups []AddMembershipMultipleGroupsResponseGroupsItem `json:"groups,omitempty"`
}

AddMembershipMultipleGroupsResponse : The response from the add member to multiple access groups request.

type AddMembershipMultipleGroupsResponseGroupsItem 

type AddMembershipMultipleGroupsResponseGroupsItem struct {
	// The access group that the member is to be added to.
	AccessGroupID *string `json:"access_group_id,omitempty"`

	// The outcome of the add membership operation on this `access_group_id`.
	StatusCode *int64 `json:"status_code,omitempty"`

	// A transaction-id that can be used for debugging purposes.
	Trace *string `json:"trace,omitempty"`

	// List of errors encountered when adding member to access group.
	Errors []Error `json:"errors,omitempty"`
}

AddMembershipMultipleGroupsResponseGroupsItem : AddMembershipMultipleGroupsResponseGroupsItem struct

type Assertions added in v0.44.0 

type Assertions struct {
	// Dynamic rules to automatically add federated users to access groups based on specific identity attributes.
	Rules []AssertionsRule `json:"rules,omitempty"`

	// Control whether or not access group administrators in child accounts can add, remove, and update dynamic rules for
	// the enterprise-managed access group in their account. The inner level RuleActionControls override these `remove` and
	// `update` action controls.
	ActionControls *AssertionsActionControls `json:"action_controls,omitempty"`
}

Assertions : Assertions Input Component.

type AssertionsActionControls added in v0.44.0 

type AssertionsActionControls struct {
	// Action control for adding dynamic rules to an enterprise-managed access group. If an access group administrator in a
	// child account adds a dynamic rule, they can always update or remove it. Note that if conflicts arise between an
	// update to this control and rules added or updated by an administrator in the child account, you must resolve those
	// conflicts in the child account. This prevents breaking access that the rules might grant in the child account. For
	// more information, see [Working with versions].
	Add *bool `json:"add,omitempty"`

	// Action control for removing enterprise-managed dynamic rules in an enterprise-managed access group. Note that if a
	// rule is removed from an enterprise-managed access group by an administrator in a child account and and you reassign
	// the template, the rule is reinstated.
	Remove *bool `json:"remove,omitempty"`
}

AssertionsActionControls : Control whether or not access group administrators in child accounts can add, remove, and update dynamic rules for the enterprise-managed access group in their account. The inner level RuleActionControls override these `remove` and `update` action controls.

type AssertionsRule added in v0.44.0 

type AssertionsRule struct {
	// Dynamic rule name.
	Name *string `json:"name,omitempty"`

	// 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.
	Expiration *int64 `json:"expiration,omitempty"`

	// The identity provider (IdP) URL.
	RealmName *string `json:"realm_name,omitempty"`

	// Conditions of membership. You can think of this as a key:value pair.
	Conditions []Conditions `json:"conditions,omitempty"`

	// Control whether or not access group administrators in child accounts can update and remove this dynamic rule in the
	// enterprise-managed access group in their account.This overrides outer level AssertionsActionControls.
	ActionControls *RuleActionControls `json:"action_controls,omitempty"`
}

AssertionsRule : Rule Input component.

type AssignmentResourceAccessGroup added in v0.44.0 

type AssignmentResourceAccessGroup struct {
	// Assignment resource entry.
	Group *AssignmentResourceEntry `json:"group" validate:"required"`

	// List of member resources of the group.
	Members []AssignmentResourceEntry `json:"members" validate:"required"`

	// List of rules associated with the group.
	Rules []AssignmentResourceEntry `json:"rules" validate:"required"`
}

AssignmentResourceAccessGroup : Assignment Resource Access Group.

type AssignmentResourceEntry added in v0.44.0 

type AssignmentResourceEntry struct {
	// Assignment Resource Entry Id.
	ID *string `json:"id" validate:"required"`

	// Optional name of the resource.
	Name *string `json:"name,omitempty"`

	// Optional version of the resource.
	Version *string `json:"version,omitempty"`

	// Resource in assignment resource entry.
	Resource *string `json:"resource" validate:"required"`

	// Error in assignment resource entry.
	Error *string `json:"error" validate:"required"`

	// Optional operation on the resource.
	Operation *string `json:"operation,omitempty"`

	// Status of assignment resource entry.
	Status *string `json:"status" validate:"required"`
}

AssignmentResourceEntry : Assignment resource entry.

type CommitTemplateOptions added in v0.44.0 

type CommitTemplateOptions struct {
	// ID of the template to commit.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// version number in path.
	VersionNum *string `json:"version_num" validate:"required,ne="`

	// ETag value of the template version document.
	IfMatch *string `json:"If-Match" validate:"required"`

	// An optional transaction id for the request.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CommitTemplateOptions : The CommitTemplate options.

func (*CommitTemplateOptions) SetHeaders added in v0.44.0 

func (options *CommitTemplateOptions) SetHeaders(param map[string]string) *CommitTemplateOptions

SetHeaders : Allow user to set Headers

func (*CommitTemplateOptions) SetIfMatch added in v0.44.0 

func (_options *CommitTemplateOptions) SetIfMatch(ifMatch string) *CommitTemplateOptions

SetIfMatch : Allow user to set IfMatch

func (*CommitTemplateOptions) SetTemplateID added in v0.44.0 

func (_options *CommitTemplateOptions) SetTemplateID(templateID string) *CommitTemplateOptions

SetTemplateID : Allow user to set TemplateID

func (*CommitTemplateOptions) SetTransactionID added in v0.44.0 

func (_options *CommitTemplateOptions) SetTransactionID(transactionID string) *CommitTemplateOptions

SetTransactionID : Allow user to set TransactionID

func (*CommitTemplateOptions) SetVersionNum added in v0.44.0 

func (_options *CommitTemplateOptions) SetVersionNum(versionNum string) *CommitTemplateOptions

SetVersionNum : Allow user to set VersionNum

type Conditions added in v0.44.0 

type Conditions struct {
	// The key in the key:value pair.
	Claim *string `json:"claim,omitempty"`

	// Compares the claim and the value.
	Operator *string `json:"operator,omitempty"`

	// The value in the key:value pair.
	Value *string `json:"value,omitempty"`
}

Conditions : Condition Input component.

type CreateAccessGroupOptions 

type CreateAccessGroupOptions struct {
	// 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.
	AccountID *string `json:"account_id" validate:"required"`

	// 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.
	Name *string `json:"name" validate:"required"`

	// Assign an optional description for the access group. This field has a limit of 250 characters.
	Description *string `json:"description,omitempty"`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateAccessGroupOptions : The CreateAccessGroup options.

func (*CreateAccessGroupOptions) SetAccountID 

func (_options *CreateAccessGroupOptions) SetAccountID(accountID string) *CreateAccessGroupOptions

SetAccountID : Allow user to set AccountID

func (*CreateAccessGroupOptions) SetDescription 

func (_options *CreateAccessGroupOptions) SetDescription(description string) *CreateAccessGroupOptions

SetDescription : Allow user to set Description

func (*CreateAccessGroupOptions) SetHeaders 

func (options *CreateAccessGroupOptions) SetHeaders(param map[string]string) *CreateAccessGroupOptions

SetHeaders : Allow user to set Headers

func (*CreateAccessGroupOptions) SetName 

func (_options *CreateAccessGroupOptions) SetName(name string) *CreateAccessGroupOptions

SetName : Allow user to set Name

func (*CreateAccessGroupOptions) SetTransactionID 

func (_options *CreateAccessGroupOptions) SetTransactionID(transactionID string) *CreateAccessGroupOptions

SetTransactionID : Allow user to set TransactionID

type CreateAssignmentOptions added in v0.44.0 

type CreateAssignmentOptions struct {
	// The unique identifier of the template to be assigned.
	TemplateID *string `json:"template_id" validate:"required"`

	// The version number of the template to be assigned.
	TemplateVersion *string `json:"template_version" validate:"required"`

	// The type of the entity to which the template should be assigned, e.g. 'Account', 'AccountGroup', etc.
	TargetType *string `json:"target_type" validate:"required"`

	// The unique identifier of the entity to which the template should be assigned.
	Target *string `json:"target" validate:"required"`

	// An optional transaction id for the request.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateAssignmentOptions : The CreateAssignment options.

func (*CreateAssignmentOptions) SetHeaders added in v0.44.0 

func (options *CreateAssignmentOptions) SetHeaders(param map[string]string) *CreateAssignmentOptions

SetHeaders : Allow user to set Headers

func (*CreateAssignmentOptions) SetTarget added in v0.44.0 

func (_options *CreateAssignmentOptions) SetTarget(target string) *CreateAssignmentOptions

SetTarget : Allow user to set Target

func (*CreateAssignmentOptions) SetTargetType added in v0.44.0 

func (_options *CreateAssignmentOptions) SetTargetType(targetType string) *CreateAssignmentOptions

SetTargetType : Allow user to set TargetType

func (*CreateAssignmentOptions) SetTemplateID added in v0.44.0 

func (_options *CreateAssignmentOptions) SetTemplateID(templateID string) *CreateAssignmentOptions

SetTemplateID : Allow user to set TemplateID

func (*CreateAssignmentOptions) SetTemplateVersion added in v0.44.0 

func (_options *CreateAssignmentOptions) SetTemplateVersion(templateVersion string) *CreateAssignmentOptions

SetTemplateVersion : Allow user to set TemplateVersion

func (*CreateAssignmentOptions) SetTransactionID added in v0.44.0 

func (_options *CreateAssignmentOptions) SetTransactionID(transactionID string) *CreateAssignmentOptions

SetTransactionID : Allow user to set TransactionID

type CreateTemplateOptions added in v0.44.0 

type CreateTemplateOptions struct {
	// Give the access group template a unique name that doesn't conflict with an existing access group templates in the
	// account.
	Name *string `json:"name" validate:"required"`

	// Enterprise account id in which the template will be created.
	AccountID *string `json:"account_id" validate:"required"`

	// Assign an optional description for the access group template.
	Description *string `json:"description,omitempty"`

	// Access Group Component.
	Group *AccessGroupRequest `json:"group,omitempty"`

	// Existing policy templates that you can reference to assign access in the Access group input component.
	PolicyTemplateReferences []PolicyTemplates `json:"policy_template_references,omitempty"`

	// An optional transaction id for the request.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateTemplateOptions : The CreateTemplate options.

func (*CreateTemplateOptions) SetAccountID added in v0.44.0 

func (_options *CreateTemplateOptions) SetAccountID(accountID string) *CreateTemplateOptions

SetAccountID : Allow user to set AccountID

func (*CreateTemplateOptions) SetDescription added in v0.44.0 

func (_options *CreateTemplateOptions) SetDescription(description string) *CreateTemplateOptions

SetDescription : Allow user to set Description

func (*CreateTemplateOptions) SetGroup added in v0.44.0 

func (_options *CreateTemplateOptions) SetGroup(group *AccessGroupRequest) *CreateTemplateOptions

SetGroup : Allow user to set Group

func (*CreateTemplateOptions) SetHeaders added in v0.44.0 

func (options *CreateTemplateOptions) SetHeaders(param map[string]string) *CreateTemplateOptions

SetHeaders : Allow user to set Headers

func (*CreateTemplateOptions) SetName added in v0.44.0 

func (_options *CreateTemplateOptions) SetName(name string) *CreateTemplateOptions

SetName : Allow user to set Name

func (*CreateTemplateOptions) SetPolicyTemplateReferences added in v0.44.0 

func (_options *CreateTemplateOptions) SetPolicyTemplateReferences(policyTemplateReferences []PolicyTemplates) *CreateTemplateOptions

SetPolicyTemplateReferences : Allow user to set PolicyTemplateReferences

func (*CreateTemplateOptions) SetTransactionID added in v0.44.0 

func (_options *CreateTemplateOptions) SetTransactionID(transactionID string) *CreateTemplateOptions

SetTransactionID : Allow user to set TransactionID

type CreateTemplateVersionOptions added in v0.44.0 

type CreateTemplateVersionOptions struct {
	// ID of the template that you want to create a new version of.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// This is an optional field. If the field is included it will change the name value for all existing versions of the
	// template..
	Name *string `json:"name,omitempty"`

	// Assign an optional description for the access group template version.
	Description *string `json:"description,omitempty"`

	// Access Group Component.
	Group *AccessGroupRequest `json:"group,omitempty"`

	// The policy templates associated with the template version.
	PolicyTemplateReferences []PolicyTemplates `json:"policy_template_references,omitempty"`

	// An optional transaction id for the request.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateTemplateVersionOptions : The CreateTemplateVersion options.

func (*CreateTemplateVersionOptions) SetDescription added in v0.44.0 

func (_options *CreateTemplateVersionOptions) SetDescription(description string) *CreateTemplateVersionOptions

SetDescription : Allow user to set Description

func (*CreateTemplateVersionOptions) SetGroup added in v0.44.0 

func (_options *CreateTemplateVersionOptions) SetGroup(group *AccessGroupRequest) *CreateTemplateVersionOptions

SetGroup : Allow user to set Group

func (*CreateTemplateVersionOptions) SetHeaders added in v0.44.0 

func (options *CreateTemplateVersionOptions) SetHeaders(param map[string]string) *CreateTemplateVersionOptions

SetHeaders : Allow user to set Headers

func (*CreateTemplateVersionOptions) SetName added in v0.44.0 

func (_options *CreateTemplateVersionOptions) SetName(name string) *CreateTemplateVersionOptions

SetName : Allow user to set Name

func (*CreateTemplateVersionOptions) SetPolicyTemplateReferences added in v0.44.0 

func (_options *CreateTemplateVersionOptions) SetPolicyTemplateReferences(policyTemplateReferences []PolicyTemplates) *CreateTemplateVersionOptions

SetPolicyTemplateReferences : Allow user to set PolicyTemplateReferences

func (*CreateTemplateVersionOptions) SetTemplateID added in v0.44.0 

func (_options *CreateTemplateVersionOptions) SetTemplateID(templateID string) *CreateTemplateVersionOptions

SetTemplateID : Allow user to set TemplateID

func (*CreateTemplateVersionOptions) SetTransactionID added in v0.44.0 

func (_options *CreateTemplateVersionOptions) SetTransactionID(transactionID string) *CreateTemplateVersionOptions

SetTransactionID : Allow user to set TransactionID

type DeleteAccessGroupOptions 

type DeleteAccessGroupOptions struct {
	// The access group identifier.
	AccessGroupID *string `json:"access_group_id" validate:"required,ne="`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// If force is true, delete the group as well as its associated members and rules.
	Force *bool `json:"force,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteAccessGroupOptions : The DeleteAccessGroup options.

func (*DeleteAccessGroupOptions) SetAccessGroupID 

func (_options *DeleteAccessGroupOptions) SetAccessGroupID(accessGroupID string) *DeleteAccessGroupOptions

SetAccessGroupID : Allow user to set AccessGroupID

func (*DeleteAccessGroupOptions) SetForce 

func (_options *DeleteAccessGroupOptions) SetForce(force bool) *DeleteAccessGroupOptions

SetForce : Allow user to set Force

func (*DeleteAccessGroupOptions) SetHeaders 

func (options *DeleteAccessGroupOptions) SetHeaders(param map[string]string) *DeleteAccessGroupOptions

SetHeaders : Allow user to set Headers

func (*DeleteAccessGroupOptions) SetTransactionID 

func (_options *DeleteAccessGroupOptions) SetTransactionID(transactionID string) *DeleteAccessGroupOptions

SetTransactionID : Allow user to set TransactionID

type DeleteAssignmentOptions added in v0.44.0 

type DeleteAssignmentOptions struct {
	// assignment id path parameter.
	AssignmentID *string `json:"assignment_id" validate:"required,ne="`

	// An optional transaction id for the request.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteAssignmentOptions : The DeleteAssignment options.

func (*DeleteAssignmentOptions) SetAssignmentID added in v0.44.0 

func (_options *DeleteAssignmentOptions) SetAssignmentID(assignmentID string) *DeleteAssignmentOptions

SetAssignmentID : Allow user to set AssignmentID

func (*DeleteAssignmentOptions) SetHeaders added in v0.44.0 

func (options *DeleteAssignmentOptions) SetHeaders(param map[string]string) *DeleteAssignmentOptions

SetHeaders : Allow user to set Headers

func (*DeleteAssignmentOptions) SetTransactionID added in v0.44.0 

func (_options *DeleteAssignmentOptions) SetTransactionID(transactionID string) *DeleteAssignmentOptions

SetTransactionID : Allow user to set TransactionID

type DeleteFromAllGroupsResponse 

type DeleteFromAllGroupsResponse struct {
	// The `iam_id` of the member to removed from groups.
	IamID *string `json:"iam_id,omitempty"`

	// The groups the member was removed from.
	Groups []DeleteFromAllGroupsResponseGroupsItem `json:"groups,omitempty"`
}

DeleteFromAllGroupsResponse : The response from the delete member from access groups request.

type DeleteFromAllGroupsResponseGroupsItem 

type DeleteFromAllGroupsResponseGroupsItem struct {
	// The access group that the member is to be deleted from.
	AccessGroupID *string `json:"access_group_id,omitempty"`

	// The outcome of the delete operation on this `access_group_id`.
	StatusCode *int64 `json:"status_code,omitempty"`

	// A transaction-id that can be used for debugging purposes.
	Trace *string `json:"trace,omitempty"`

	// A list of errors that occurred when trying to remove a member from groups.
	Errors []Error `json:"errors,omitempty"`
}

DeleteFromAllGroupsResponseGroupsItem : DeleteFromAllGroupsResponseGroupsItem struct

type DeleteGroupBulkMembersResponse 

type DeleteGroupBulkMembersResponse struct {
	// The access group id.
	AccessGroupID *string `json:"access_group_id,omitempty"`

	// The `iam_id`s removed from the access group.
	Members []DeleteGroupBulkMembersResponseMembersItem `json:"members,omitempty"`
}

DeleteGroupBulkMembersResponse : The access group id and the members removed from it.

type DeleteGroupBulkMembersResponseMembersItem 

type DeleteGroupBulkMembersResponseMembersItem struct {
	// The `iam_id` to be deleted.
	IamID *string `json:"iam_id,omitempty"`

	// A transaction-id that can be used for debugging purposes.
	Trace *string `json:"trace,omitempty"`

	// The outcome of the delete membership operation on this `access_group_id`.
	StatusCode *int64 `json:"status_code,omitempty"`

	// A list of errors that occurred when trying to remove a member from groups.
	Errors []Error `json:"errors,omitempty"`
}

DeleteGroupBulkMembersResponseMembersItem : DeleteGroupBulkMembersResponseMembersItem struct

type DeleteTemplateOptions added in v0.44.0 

type DeleteTemplateOptions struct {
	// template id parameter.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// An optional transaction id for the request.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteTemplateOptions : The DeleteTemplate options.

func (*DeleteTemplateOptions) SetHeaders added in v0.44.0 

func (options *DeleteTemplateOptions) SetHeaders(param map[string]string) *DeleteTemplateOptions

SetHeaders : Allow user to set Headers

func (*DeleteTemplateOptions) SetTemplateID added in v0.44.0 

func (_options *DeleteTemplateOptions) SetTemplateID(templateID string) *DeleteTemplateOptions

SetTemplateID : Allow user to set TemplateID

func (*DeleteTemplateOptions) SetTransactionID added in v0.44.0 

func (_options *DeleteTemplateOptions) SetTransactionID(transactionID string) *DeleteTemplateOptions

SetTransactionID : Allow user to set TransactionID

type DeleteTemplateVersionOptions added in v0.44.0 

type DeleteTemplateVersionOptions struct {
	// ID of the template to delete.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// version number in path.
	VersionNum *string `json:"version_num" validate:"required,ne="`

	// An optional transaction id for the request.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteTemplateVersionOptions : The DeleteTemplateVersion options.

func (*DeleteTemplateVersionOptions) SetHeaders added in v0.44.0 

func (options *DeleteTemplateVersionOptions) SetHeaders(param map[string]string) *DeleteTemplateVersionOptions

SetHeaders : Allow user to set Headers

func (*DeleteTemplateVersionOptions) SetTemplateID added in v0.44.0 

func (_options *DeleteTemplateVersionOptions) SetTemplateID(templateID string) *DeleteTemplateVersionOptions

SetTemplateID : Allow user to set TemplateID

func (*DeleteTemplateVersionOptions) SetTransactionID added in v0.44.0 

func (_options *DeleteTemplateVersionOptions) SetTransactionID(transactionID string) *DeleteTemplateVersionOptions

SetTransactionID : Allow user to set TransactionID

func (*DeleteTemplateVersionOptions) SetVersionNum added in v0.44.0 

func (_options *DeleteTemplateVersionOptions) SetVersionNum(versionNum string) *DeleteTemplateVersionOptions

SetVersionNum : Allow user to set VersionNum

type Error 

type Error struct {
	// A human-readable error code represented by a snake case string.
	Code *string `json:"code,omitempty"`

	// A specific error message that details the issue or an action to take.
	Message *string `json:"message,omitempty"`
}

Error : Error contains the code and message for an error returned to the user code is a string identifying the problem, examples "missing_field", "reserved_value" message is a string explaining the solution to the problem that was encountered.

type GetAccessGroupOptions 

type GetAccessGroupOptions struct {
	// The access group identifier.
	AccessGroupID *string `json:"access_group_id" validate:"required,ne="`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// If show_federated is true, the group will return an is_federated value that is set to true if rules exist for the
	// group.
	ShowFederated *bool `json:"show_federated,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetAccessGroupOptions : The GetAccessGroup options.

func (*GetAccessGroupOptions) SetAccessGroupID 

func (_options *GetAccessGroupOptions) SetAccessGroupID(accessGroupID string) *GetAccessGroupOptions

SetAccessGroupID : Allow user to set AccessGroupID

func (*GetAccessGroupOptions) SetHeaders 

func (options *GetAccessGroupOptions) SetHeaders(param map[string]string) *GetAccessGroupOptions

SetHeaders : Allow user to set Headers

func (*GetAccessGroupOptions) SetShowFederated 

func (_options *GetAccessGroupOptions) SetShowFederated(showFederated bool) *GetAccessGroupOptions

SetShowFederated : Allow user to set ShowFederated

func (*GetAccessGroupOptions) SetTransactionID 

func (_options *GetAccessGroupOptions) SetTransactionID(transactionID string) *GetAccessGroupOptions

SetTransactionID : Allow user to set TransactionID

type GetAccessGroupRuleOptions 

type GetAccessGroupRuleOptions struct {
	// The access group identifier.
	AccessGroupID *string `json:"access_group_id" validate:"required,ne="`

	// The rule to get.
	RuleID *string `json:"rule_id" validate:"required,ne="`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetAccessGroupRuleOptions : The GetAccessGroupRule options.

func (*GetAccessGroupRuleOptions) SetAccessGroupID 

func (_options *GetAccessGroupRuleOptions) SetAccessGroupID(accessGroupID string) *GetAccessGroupRuleOptions

SetAccessGroupID : Allow user to set AccessGroupID

func (*GetAccessGroupRuleOptions) SetHeaders 

func (options *GetAccessGroupRuleOptions) SetHeaders(param map[string]string) *GetAccessGroupRuleOptions

SetHeaders : Allow user to set Headers

func (*GetAccessGroupRuleOptions) SetRuleID 

func (_options *GetAccessGroupRuleOptions) SetRuleID(ruleID string) *GetAccessGroupRuleOptions

SetRuleID : Allow user to set RuleID

func (*GetAccessGroupRuleOptions) SetTransactionID 

func (_options *GetAccessGroupRuleOptions) SetTransactionID(transactionID string) *GetAccessGroupRuleOptions

SetTransactionID : Allow user to set TransactionID

type GetAccountSettingsOptions 

type GetAccountSettingsOptions struct {
	// 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.
	AccountID *string `json:"account_id" validate:"required"`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetAccountSettingsOptions : The GetAccountSettings options.

func (*GetAccountSettingsOptions) SetAccountID 

func (_options *GetAccountSettingsOptions) SetAccountID(accountID string) *GetAccountSettingsOptions

SetAccountID : Allow user to set AccountID

func (*GetAccountSettingsOptions) SetHeaders 

func (options *GetAccountSettingsOptions) SetHeaders(param map[string]string) *GetAccountSettingsOptions

SetHeaders : Allow user to set Headers

func (*GetAccountSettingsOptions) SetTransactionID 

func (_options *GetAccountSettingsOptions) SetTransactionID(transactionID string) *GetAccountSettingsOptions

SetTransactionID : Allow user to set TransactionID

type GetAssignmentOptions added in v0.44.0 

type GetAssignmentOptions struct {
	// Assignment ID.
	AssignmentID *string `json:"assignment_id" validate:"required,ne="`

	// An optional transaction id for the request.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Returns resources access group template assigned, possible values `true` or `false`.
	Verbose *bool `json:"verbose,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetAssignmentOptions : The GetAssignment options.

func (*GetAssignmentOptions) SetAssignmentID added in v0.44.0 

func (_options *GetAssignmentOptions) SetAssignmentID(assignmentID string) *GetAssignmentOptions

SetAssignmentID : Allow user to set AssignmentID

func (*GetAssignmentOptions) SetHeaders added in v0.44.0 

func (options *GetAssignmentOptions) SetHeaders(param map[string]string) *GetAssignmentOptions

SetHeaders : Allow user to set Headers

func (*GetAssignmentOptions) SetTransactionID added in v0.44.0 

func (_options *GetAssignmentOptions) SetTransactionID(transactionID string) *GetAssignmentOptions

SetTransactionID : Allow user to set TransactionID

func (*GetAssignmentOptions) SetVerbose added in v0.44.0 

func (_options *GetAssignmentOptions) SetVerbose(verbose bool) *GetAssignmentOptions

SetVerbose : Allow user to set Verbose

type GetLatestTemplateVersionOptions added in v0.44.0 

type GetLatestTemplateVersionOptions struct {
	// ID of the template to get a specific version of.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// If `verbose=true`, IAM resource details are returned. If performance is a concern, leave the `verbose` parameter off
	// so that details are not retrieved.
	Verbose *bool `json:"verbose,omitempty"`

	// An optional transaction id for the request.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetLatestTemplateVersionOptions : The GetLatestTemplateVersion options.

func (*GetLatestTemplateVersionOptions) SetHeaders added in v0.44.0 

func (options *GetLatestTemplateVersionOptions) SetHeaders(param map[string]string) *GetLatestTemplateVersionOptions

SetHeaders : Allow user to set Headers

func (*GetLatestTemplateVersionOptions) SetTemplateID added in v0.44.0 

func (_options *GetLatestTemplateVersionOptions) SetTemplateID(templateID string) *GetLatestTemplateVersionOptions

SetTemplateID : Allow user to set TemplateID

func (*GetLatestTemplateVersionOptions) SetTransactionID added in v0.44.0 

func (_options *GetLatestTemplateVersionOptions) SetTransactionID(transactionID string) *GetLatestTemplateVersionOptions

SetTransactionID : Allow user to set TransactionID

func (*GetLatestTemplateVersionOptions) SetVerbose added in v0.44.0 

func (_options *GetLatestTemplateVersionOptions) SetVerbose(verbose bool) *GetLatestTemplateVersionOptions

SetVerbose : Allow user to set Verbose

type GetTemplateVersionOptions added in v0.44.0 

type GetTemplateVersionOptions struct {
	// ID of the template to get a specific version of.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// Version number.
	VersionNum *string `json:"version_num" validate:"required,ne="`

	// If `verbose=true`, IAM resource details are returned. If performance is a concern, leave the `verbose` parameter off
	// so that details are not retrieved.
	Verbose *bool `json:"verbose,omitempty"`

	// An optional transaction id for the request.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetTemplateVersionOptions : The GetTemplateVersion options.

func (*GetTemplateVersionOptions) SetHeaders added in v0.44.0 

func (options *GetTemplateVersionOptions) SetHeaders(param map[string]string) *GetTemplateVersionOptions

SetHeaders : Allow user to set Headers

func (*GetTemplateVersionOptions) SetTemplateID added in v0.44.0 

func (_options *GetTemplateVersionOptions) SetTemplateID(templateID string) *GetTemplateVersionOptions

SetTemplateID : Allow user to set TemplateID

func (*GetTemplateVersionOptions) SetTransactionID added in v0.44.0 

func (_options *GetTemplateVersionOptions) SetTransactionID(transactionID string) *GetTemplateVersionOptions

SetTransactionID : Allow user to set TransactionID

func (*GetTemplateVersionOptions) SetVerbose added in v0.44.0 

func (_options *GetTemplateVersionOptions) SetVerbose(verbose bool) *GetTemplateVersionOptions

SetVerbose : Allow user to set Verbose

func (*GetTemplateVersionOptions) SetVersionNum added in v0.44.0 

func (_options *GetTemplateVersionOptions) SetVersionNum(versionNum string) *GetTemplateVersionOptions

SetVersionNum : Allow user to set VersionNum

type Group 

type Group struct {
	// The group's access group ID.
	ID *string `json:"id,omitempty"`

	// The group's name.
	Name *string `json:"name,omitempty"`

	// The group's description - if defined.
	Description *string `json:"description,omitempty"`

	// The account id where the group was created.
	AccountID *string `json:"account_id,omitempty"`

	// The timestamp of when the group was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The `iam_id` of the entity that created the group.
	CreatedByID *string `json:"created_by_id,omitempty"`

	// The timestamp of when the group was last edited.
	LastModifiedAt *strfmt.DateTime `json:"last_modified_at,omitempty"`

	// The `iam_id` of the entity that last modified the group name or description.
	LastModifiedByID *string `json:"last_modified_by_id,omitempty"`

	// A url to the given group resource.
	Href *string `json:"href,omitempty"`

	// This is set to true if rules exist for the group.
	IsFederated *bool `json:"is_federated,omitempty"`
}

Group : An IAM access group.

type GroupActionControls added in v0.44.0 

type GroupActionControls struct {
	// Control whether or not access group administrators in child accounts can add access policies to the
	// enterprise-managed access group in their account.
	Access *AccessActionControls `json:"access,omitempty"`
}

GroupActionControls : Access group action controls component.

type GroupMembersList 

type GroupMembersList struct {
	// Limit on how many items can be returned.
	Limit *int64 `json:"limit" validate:"required"`

	// The offset of the first item returned in the result set.
	Offset *int64 `json:"offset" validate:"required"`

	// The total number of items that match the query.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// A link object.
	First *HrefStruct `json:"first,omitempty"`

	// A link object.
	Previous *HrefStruct `json:"previous,omitempty"`

	// A link object.
	Next *HrefStruct `json:"next,omitempty"`

	// A link object.
	Last *HrefStruct `json:"last,omitempty"`

	// The members of an access group.
	Members []ListGroupMembersResponseMember `json:"members,omitempty"`
}

GroupMembersList : The members of a group.

func (*GroupMembersList) GetNextOffset added in v0.18.19 

func (resp *GroupMembersList) GetNextOffset() (*int64, error)

Retrieve the value to be passed to a request to access the next page of results

type GroupTemplate added in v0.44.0 

type GroupTemplate struct {
	// The ID of the access group template.
	ID *string `json:"id" validate:"required"`

	// The name of the access group template.
	Name *string `json:"name" validate:"required"`

	// The description of the access group template.
	Description *string `json:"description" validate:"required"`

	// The version of the access group template.
	Version *string `json:"version" validate:"required"`

	// A boolean indicating whether the access group template is committed. You must commit a template before you can
	// assign it to child accounts.
	Committed *bool `json:"committed" validate:"required"`

	// Access Group Component.
	Group *AccessGroupResponse `json:"group" validate:"required"`

	// References to policy templates assigned to the access group template.
	PolicyTemplateReferences []PolicyTemplates `json:"policy_template_references" validate:"required"`

	// The URL of the access group template resource.
	Href *string `json:"href" validate:"required"`

	// The date and time when the access group template was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The ID of the user who created the access group template.
	CreatedByID *string `json:"created_by_id" validate:"required"`

	// The date and time when the access group template was last modified.
	LastModifiedAt *strfmt.DateTime `json:"last_modified_at" validate:"required"`

	// The ID of the user who last modified the access group template.
	LastModifiedByID *string `json:"last_modified_by_id" validate:"required"`
}

GroupTemplate : Response output for template.

type GroupsList 

type GroupsList struct {
	// Limit on how many items can be returned.
	Limit *int64 `json:"limit" validate:"required"`

	// The offset of the first item returned in the result set.
	Offset *int64 `json:"offset" validate:"required"`

	// The total number of items that match the query.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// A link object.
	First *HrefStruct `json:"first,omitempty"`

	// A link object.
	Previous *HrefStruct `json:"previous,omitempty"`

	// A link object.
	Next *HrefStruct `json:"next,omitempty"`

	// A link object.
	Last *HrefStruct `json:"last,omitempty"`

	// An array of access groups.
	Groups []Group `json:"groups,omitempty"`
}

GroupsList : The list of access groups returned as part of a response.

func (*GroupsList) GetNextOffset added in v0.18.19 

func (resp *GroupsList) GetNextOffset() (*int64, error)

Retrieve the value to be passed to a request to access the next page of results

type HrefStruct 

type HrefStruct struct {
	// A string containing the link’s URL.
	Href *string `json:"href,omitempty"`
}

HrefStruct : A link object.

type IamAccessGroupsV2 

type IamAccessGroupsV2 struct {
	Service *core.BaseService
}

IamAccessGroupsV2 : The IAM Access Groups API allows for the management of access groups (Create, Read, Update, Delete) as well as the management of memberships and rules within the group container.

API Version: 2.0

func NewIamAccessGroupsV2 

func NewIamAccessGroupsV2(options *IamAccessGroupsV2Options) (service *IamAccessGroupsV2, err error)

NewIamAccessGroupsV2 : constructs an instance of IamAccessGroupsV2 with passed in options.

func NewIamAccessGroupsV2UsingExternalConfig 

func NewIamAccessGroupsV2UsingExternalConfig(options *IamAccessGroupsV2Options) (iamAccessGroups *IamAccessGroupsV2, err error)

NewIamAccessGroupsV2UsingExternalConfig : constructs an instance of IamAccessGroupsV2 with passed in options and external configuration.

func (*IamAccessGroupsV2) AddAccessGroupRule 

func (iamAccessGroups *IamAccessGroupsV2) AddAccessGroupRule(addAccessGroupRuleOptions *AddAccessGroupRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

AddAccessGroupRule : Create rule for an access group 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.](/docs/account?topic=account-rules).

func (*IamAccessGroupsV2) AddAccessGroupRuleWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) AddAccessGroupRuleWithContext(ctx context.Context, addAccessGroupRuleOptions *AddAccessGroupRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

AddAccessGroupRuleWithContext is an alternate form of the AddAccessGroupRule method which supports a Context parameter

func (*IamAccessGroupsV2) AddMemberToMultipleAccessGroups 

func (iamAccessGroups *IamAccessGroupsV2) AddMemberToMultipleAccessGroups(addMemberToMultipleAccessGroupsOptions *AddMemberToMultipleAccessGroupsOptions) (result *AddMembershipMultipleGroupsResponse, response *core.DetailedResponse, err error)

AddMemberToMultipleAccessGroups : Add member to multiple access groups 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.

func (*IamAccessGroupsV2) AddMemberToMultipleAccessGroupsWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) AddMemberToMultipleAccessGroupsWithContext(ctx context.Context, addMemberToMultipleAccessGroupsOptions *AddMemberToMultipleAccessGroupsOptions) (result *AddMembershipMultipleGroupsResponse, response *core.DetailedResponse, err error)

AddMemberToMultipleAccessGroupsWithContext is an alternate form of the AddMemberToMultipleAccessGroups method which supports a Context parameter

func (*IamAccessGroupsV2) AddMembersToAccessGroup 

func (iamAccessGroups *IamAccessGroupsV2) AddMembersToAccessGroup(addMembersToAccessGroupOptions *AddMembersToAccessGroupOptions) (result *AddGroupMembersResponse, response *core.DetailedResponse, err error)

AddMembersToAccessGroup : Add members to an access group 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.

func (*IamAccessGroupsV2) AddMembersToAccessGroupWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) AddMembersToAccessGroupWithContext(ctx context.Context, addMembersToAccessGroupOptions *AddMembersToAccessGroupOptions) (result *AddGroupMembersResponse, response *core.DetailedResponse, err error)

AddMembersToAccessGroupWithContext is an alternate form of the AddMembersToAccessGroup method which supports a Context parameter

func (*IamAccessGroupsV2) Clone added in v0.17.2 

func (iamAccessGroups *IamAccessGroupsV2) Clone() *IamAccessGroupsV2

Clone makes a copy of "iamAccessGroups" suitable for processing requests.

func (*IamAccessGroupsV2) CommitTemplate added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) CommitTemplate(commitTemplateOptions *CommitTemplateOptions) (response *core.DetailedResponse, err error)

CommitTemplate : Commit a template 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.

func (*IamAccessGroupsV2) CommitTemplateWithContext added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) CommitTemplateWithContext(ctx context.Context, commitTemplateOptions *CommitTemplateOptions) (response *core.DetailedResponse, err error)

CommitTemplateWithContext is an alternate form of the CommitTemplate method which supports a Context parameter

func (*IamAccessGroupsV2) CreateAccessGroup 

func (iamAccessGroups *IamAccessGroupsV2) CreateAccessGroup(createAccessGroupOptions *CreateAccessGroupOptions) (result *Group, response *core.DetailedResponse, err error)

CreateAccessGroup : Create an access group 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.

func (*IamAccessGroupsV2) CreateAccessGroupWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) CreateAccessGroupWithContext(ctx context.Context, createAccessGroupOptions *CreateAccessGroupOptions) (result *Group, response *core.DetailedResponse, err error)

CreateAccessGroupWithContext is an alternate form of the CreateAccessGroup method which supports a Context parameter

func (*IamAccessGroupsV2) CreateAssignment added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) CreateAssignment(createAssignmentOptions *CreateAssignmentOptions) (result *TemplateAssignmentResponse, response *core.DetailedResponse, err error)

CreateAssignment : Create assignment 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.

func (*IamAccessGroupsV2) CreateAssignmentWithContext added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) CreateAssignmentWithContext(ctx context.Context, createAssignmentOptions *CreateAssignmentOptions) (result *TemplateAssignmentResponse, response *core.DetailedResponse, err error)

CreateAssignmentWithContext is an alternate form of the CreateAssignment method which supports a Context parameter

func (*IamAccessGroupsV2) CreateTemplate added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) CreateTemplate(createTemplateOptions *CreateTemplateOptions) (result *TemplateResponse, response *core.DetailedResponse, err error)

CreateTemplate : Create template 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.

func (*IamAccessGroupsV2) CreateTemplateVersion added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) CreateTemplateVersion(createTemplateVersionOptions *CreateTemplateVersionOptions) (result *TemplateVersionResponse, response *core.DetailedResponse, err error)

CreateTemplateVersion : Create template version Create a new version of an access group template.

func (*IamAccessGroupsV2) CreateTemplateVersionWithContext added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) CreateTemplateVersionWithContext(ctx context.Context, createTemplateVersionOptions *CreateTemplateVersionOptions) (result *TemplateVersionResponse, response *core.DetailedResponse, err error)

CreateTemplateVersionWithContext is an alternate form of the CreateTemplateVersion method which supports a Context parameter

func (*IamAccessGroupsV2) CreateTemplateWithContext added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) CreateTemplateWithContext(ctx context.Context, createTemplateOptions *CreateTemplateOptions) (result *TemplateResponse, response *core.DetailedResponse, err error)

CreateTemplateWithContext is an alternate form of the CreateTemplate method which supports a Context parameter

func (*IamAccessGroupsV2) DeleteAccessGroup 

func (iamAccessGroups *IamAccessGroupsV2) DeleteAccessGroup(deleteAccessGroupOptions *DeleteAccessGroupOptions) (response *core.DetailedResponse, err error)

DeleteAccessGroup : Delete an access group 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.

func (*IamAccessGroupsV2) DeleteAccessGroupWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) DeleteAccessGroupWithContext(ctx context.Context, deleteAccessGroupOptions *DeleteAccessGroupOptions) (response *core.DetailedResponse, err error)

DeleteAccessGroupWithContext is an alternate form of the DeleteAccessGroup method which supports a Context parameter

func (*IamAccessGroupsV2) DeleteAssignment added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) DeleteAssignment(deleteAssignmentOptions *DeleteAssignmentOptions) (response *core.DetailedResponse, err error)

DeleteAssignment : Delete assignment Delete an access group template assignment.

func (*IamAccessGroupsV2) DeleteAssignmentWithContext added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) DeleteAssignmentWithContext(ctx context.Context, deleteAssignmentOptions *DeleteAssignmentOptions) (response *core.DetailedResponse, err error)

DeleteAssignmentWithContext is an alternate form of the DeleteAssignment method which supports a Context parameter

func (*IamAccessGroupsV2) DeleteTemplate added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) DeleteTemplate(deleteTemplateOptions *DeleteTemplateOptions) (response *core.DetailedResponse, err error)

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

func (*IamAccessGroupsV2) DeleteTemplateVersion added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) DeleteTemplateVersion(deleteTemplateVersionOptions *DeleteTemplateVersionOptions) (response *core.DetailedResponse, err error)

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

func (*IamAccessGroupsV2) DeleteTemplateVersionWithContext added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) DeleteTemplateVersionWithContext(ctx context.Context, deleteTemplateVersionOptions *DeleteTemplateVersionOptions) (response *core.DetailedResponse, err error)

DeleteTemplateVersionWithContext is an alternate form of the DeleteTemplateVersion method which supports a Context parameter

func (*IamAccessGroupsV2) DeleteTemplateWithContext added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) DeleteTemplateWithContext(ctx context.Context, deleteTemplateOptions *DeleteTemplateOptions) (response *core.DetailedResponse, err error)

DeleteTemplateWithContext is an alternate form of the DeleteTemplate method which supports a Context parameter

func (*IamAccessGroupsV2) DisableRetries added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*IamAccessGroupsV2) EnableRetries added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*IamAccessGroupsV2) GetAccessGroup 

func (iamAccessGroups *IamAccessGroupsV2) GetAccessGroup(getAccessGroupOptions *GetAccessGroupOptions) (result *Group, response *core.DetailedResponse, err error)

GetAccessGroup : Get an access group 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.

func (*IamAccessGroupsV2) GetAccessGroupRule 

func (iamAccessGroups *IamAccessGroupsV2) GetAccessGroupRule(getAccessGroupRuleOptions *GetAccessGroupRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

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

func (*IamAccessGroupsV2) GetAccessGroupRuleWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) GetAccessGroupRuleWithContext(ctx context.Context, getAccessGroupRuleOptions *GetAccessGroupRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

GetAccessGroupRuleWithContext is an alternate form of the GetAccessGroupRule method which supports a Context parameter

func (*IamAccessGroupsV2) GetAccessGroupWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) GetAccessGroupWithContext(ctx context.Context, getAccessGroupOptions *GetAccessGroupOptions) (result *Group, response *core.DetailedResponse, err error)

GetAccessGroupWithContext is an alternate form of the GetAccessGroup method which supports a Context parameter

func (*IamAccessGroupsV2) GetAccountSettings 

func (iamAccessGroups *IamAccessGroupsV2) GetAccountSettings(getAccountSettingsOptions *GetAccountSettingsOptions) (result *AccountSettings, response *core.DetailedResponse, err error)

GetAccountSettings : Get account settings Retrieve the access groups settings for a specific account.

func (*IamAccessGroupsV2) GetAccountSettingsWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) GetAccountSettingsWithContext(ctx context.Context, getAccountSettingsOptions *GetAccountSettingsOptions) (result *AccountSettings, response *core.DetailedResponse, err error)

GetAccountSettingsWithContext is an alternate form of the GetAccountSettings method which supports a Context parameter

func (*IamAccessGroupsV2) GetAssignment added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) GetAssignment(getAssignmentOptions *GetAssignmentOptions) (result *TemplateAssignmentVerboseResponse, response *core.DetailedResponse, err error)

GetAssignment : Get assignment Get a specific template assignment.

func (*IamAccessGroupsV2) GetAssignmentWithContext added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) GetAssignmentWithContext(ctx context.Context, getAssignmentOptions *GetAssignmentOptions) (result *TemplateAssignmentVerboseResponse, response *core.DetailedResponse, err error)

GetAssignmentWithContext is an alternate form of the GetAssignment method which supports a Context parameter

func (*IamAccessGroupsV2) GetEnableGzipCompression added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*IamAccessGroupsV2) GetLatestTemplateVersion added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) GetLatestTemplateVersion(getLatestTemplateVersionOptions *GetLatestTemplateVersionOptions) (result *TemplateVersionResponse, response *core.DetailedResponse, err error)

GetLatestTemplateVersion : Get latest template version Get the latest version of a template.

func (*IamAccessGroupsV2) GetLatestTemplateVersionWithContext added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) GetLatestTemplateVersionWithContext(ctx context.Context, getLatestTemplateVersionOptions *GetLatestTemplateVersionOptions) (result *TemplateVersionResponse, response *core.DetailedResponse, err error)

GetLatestTemplateVersionWithContext is an alternate form of the GetLatestTemplateVersion method which supports a Context parameter

func (*IamAccessGroupsV2) GetServiceURL added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) GetServiceURL() string

GetServiceURL returns the service URL

func (*IamAccessGroupsV2) GetTemplateVersion added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) GetTemplateVersion(getTemplateVersionOptions *GetTemplateVersionOptions) (result *TemplateVersionResponse, response *core.DetailedResponse, err error)

GetTemplateVersion : Get template version Get a specific version of a template.

func (*IamAccessGroupsV2) GetTemplateVersionWithContext added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) GetTemplateVersionWithContext(ctx context.Context, getTemplateVersionOptions *GetTemplateVersionOptions) (result *TemplateVersionResponse, response *core.DetailedResponse, err error)

GetTemplateVersionWithContext is an alternate form of the GetTemplateVersion method which supports a Context parameter

func (*IamAccessGroupsV2) IsMemberOfAccessGroup 

func (iamAccessGroups *IamAccessGroupsV2) IsMemberOfAccessGroup(isMemberOfAccessGroupOptions *IsMemberOfAccessGroupOptions) (response *core.DetailedResponse, err error)

IsMemberOfAccessGroup : Check membership in an access group 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.

func (*IamAccessGroupsV2) IsMemberOfAccessGroupWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) IsMemberOfAccessGroupWithContext(ctx context.Context, isMemberOfAccessGroupOptions *IsMemberOfAccessGroupOptions) (response *core.DetailedResponse, err error)

IsMemberOfAccessGroupWithContext is an alternate form of the IsMemberOfAccessGroup method which supports a Context parameter

func (*IamAccessGroupsV2) ListAccessGroupMembers 

func (iamAccessGroups *IamAccessGroupsV2) ListAccessGroupMembers(listAccessGroupMembersOptions *ListAccessGroupMembersOptions) (result *GroupMembersList, response *core.DetailedResponse, err error)

ListAccessGroupMembers : List access group 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.

func (*IamAccessGroupsV2) ListAccessGroupMembersWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) ListAccessGroupMembersWithContext(ctx context.Context, listAccessGroupMembersOptions *ListAccessGroupMembersOptions) (result *GroupMembersList, response *core.DetailedResponse, err error)

ListAccessGroupMembersWithContext is an alternate form of the ListAccessGroupMembers method which supports a Context parameter

func (*IamAccessGroupsV2) ListAccessGroupRules 

func (iamAccessGroups *IamAccessGroupsV2) ListAccessGroupRules(listAccessGroupRulesOptions *ListAccessGroupRulesOptions) (result *RulesList, response *core.DetailedResponse, err error)

ListAccessGroupRules : List access group 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.

func (*IamAccessGroupsV2) ListAccessGroupRulesWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) ListAccessGroupRulesWithContext(ctx context.Context, listAccessGroupRulesOptions *ListAccessGroupRulesOptions) (result *RulesList, response *core.DetailedResponse, err error)

ListAccessGroupRulesWithContext is an alternate form of the ListAccessGroupRules method which supports a Context parameter

func (*IamAccessGroupsV2) ListAccessGroups 

func (iamAccessGroups *IamAccessGroupsV2) ListAccessGroups(listAccessGroupsOptions *ListAccessGroupsOptions) (result *GroupsList, response *core.DetailedResponse, err error)

ListAccessGroups : List access 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.

func (*IamAccessGroupsV2) ListAccessGroupsWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) ListAccessGroupsWithContext(ctx context.Context, listAccessGroupsOptions *ListAccessGroupsOptions) (result *GroupsList, response *core.DetailedResponse, err error)

ListAccessGroupsWithContext is an alternate form of the ListAccessGroups method which supports a Context parameter

func (*IamAccessGroupsV2) ListAssignments added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) ListAssignments(listAssignmentsOptions *ListAssignmentsOptions) (result *ListTemplateAssignmentResponse, response *core.DetailedResponse, err error)

ListAssignments : List assignments List template assignments from an enterprise account.

func (*IamAccessGroupsV2) ListAssignmentsWithContext added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) ListAssignmentsWithContext(ctx context.Context, listAssignmentsOptions *ListAssignmentsOptions) (result *ListTemplateAssignmentResponse, response *core.DetailedResponse, err error)

ListAssignmentsWithContext is an alternate form of the ListAssignments method which supports a Context parameter

func (*IamAccessGroupsV2) ListTemplateVersions added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) ListTemplateVersions(listTemplateVersionsOptions *ListTemplateVersionsOptions) (result *ListTemplateVersionsResponse, response *core.DetailedResponse, err error)

ListTemplateVersions : List template versions List all the versions of an access group template.

func (*IamAccessGroupsV2) ListTemplateVersionsWithContext added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) ListTemplateVersionsWithContext(ctx context.Context, listTemplateVersionsOptions *ListTemplateVersionsOptions) (result *ListTemplateVersionsResponse, response *core.DetailedResponse, err error)

ListTemplateVersionsWithContext is an alternate form of the ListTemplateVersions method which supports a Context parameter

func (*IamAccessGroupsV2) ListTemplates added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) ListTemplates(listTemplatesOptions *ListTemplatesOptions) (result *ListTemplatesResponse, response *core.DetailedResponse, err error)

ListTemplates : List templates List the access group templates in an enterprise account.

func (*IamAccessGroupsV2) ListTemplatesWithContext added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) ListTemplatesWithContext(ctx context.Context, listTemplatesOptions *ListTemplatesOptions) (result *ListTemplatesResponse, response *core.DetailedResponse, err error)

ListTemplatesWithContext is an alternate form of the ListTemplates method which supports a Context parameter

func (*IamAccessGroupsV2) NewAccessGroupMembersPager added in v0.29.1 

func (iamAccessGroups *IamAccessGroupsV2) NewAccessGroupMembersPager(options *ListAccessGroupMembersOptions) (pager *AccessGroupMembersPager, err error)

NewAccessGroupMembersPager returns a new AccessGroupMembersPager instance.

func (*IamAccessGroupsV2) NewAccessGroupRequest added in v0.44.0 

func (*IamAccessGroupsV2) NewAccessGroupRequest(name string) (_model *AccessGroupRequest, err error)

NewAccessGroupRequest : Instantiate AccessGroupRequest (Generic Model Constructor)

func (*IamAccessGroupsV2) NewAccessGroupsPager added in v0.29.1 

func (iamAccessGroups *IamAccessGroupsV2) NewAccessGroupsPager(options *ListAccessGroupsOptions) (pager *AccessGroupsPager, err error)

NewAccessGroupsPager returns a new AccessGroupsPager instance.

func (*IamAccessGroupsV2) NewAddAccessGroupRuleOptions 

func (*IamAccessGroupsV2) NewAddAccessGroupRuleOptions(accessGroupID string, expiration int64, realmName string, conditions []RuleConditions) *AddAccessGroupRuleOptions

NewAddAccessGroupRuleOptions : Instantiate AddAccessGroupRuleOptions

func (*IamAccessGroupsV2) NewAddGroupMembersRequestMembersItem 

func (*IamAccessGroupsV2) NewAddGroupMembersRequestMembersItem(iamID string, typeVar string) (_model *AddGroupMembersRequestMembersItem, err error)

NewAddGroupMembersRequestMembersItem : Instantiate AddGroupMembersRequestMembersItem (Generic Model Constructor)

func (*IamAccessGroupsV2) NewAddMemberToMultipleAccessGroupsOptions 

func (*IamAccessGroupsV2) NewAddMemberToMultipleAccessGroupsOptions(accountID string, iamID string) *AddMemberToMultipleAccessGroupsOptions

NewAddMemberToMultipleAccessGroupsOptions : Instantiate AddMemberToMultipleAccessGroupsOptions

func (*IamAccessGroupsV2) NewAddMembersToAccessGroupOptions 

func (*IamAccessGroupsV2) NewAddMembersToAccessGroupOptions(accessGroupID string) *AddMembersToAccessGroupOptions

NewAddMembersToAccessGroupOptions : Instantiate AddMembersToAccessGroupOptions

func (*IamAccessGroupsV2) NewCommitTemplateOptions added in v0.44.0 

func (*IamAccessGroupsV2) NewCommitTemplateOptions(templateID string, versionNum string, ifMatch string) *CommitTemplateOptions

NewCommitTemplateOptions : Instantiate CommitTemplateOptions

func (*IamAccessGroupsV2) NewCreateAccessGroupOptions 

func (*IamAccessGroupsV2) NewCreateAccessGroupOptions(accountID string, name string) *CreateAccessGroupOptions

NewCreateAccessGroupOptions : Instantiate CreateAccessGroupOptions

func (*IamAccessGroupsV2) NewCreateAssignmentOptions added in v0.44.0 

func (*IamAccessGroupsV2) NewCreateAssignmentOptions(templateID string, templateVersion string, targetType string, target string) *CreateAssignmentOptions

NewCreateAssignmentOptions : Instantiate CreateAssignmentOptions

func (*IamAccessGroupsV2) NewCreateTemplateOptions added in v0.44.0 

func (*IamAccessGroupsV2) NewCreateTemplateOptions(name string, accountID string) *CreateTemplateOptions

NewCreateTemplateOptions : Instantiate CreateTemplateOptions

func (*IamAccessGroupsV2) NewCreateTemplateVersionOptions added in v0.44.0 

func (*IamAccessGroupsV2) NewCreateTemplateVersionOptions(templateID string) *CreateTemplateVersionOptions

NewCreateTemplateVersionOptions : Instantiate CreateTemplateVersionOptions

func (*IamAccessGroupsV2) NewDeleteAccessGroupOptions 

func (*IamAccessGroupsV2) NewDeleteAccessGroupOptions(accessGroupID string) *DeleteAccessGroupOptions

NewDeleteAccessGroupOptions : Instantiate DeleteAccessGroupOptions

func (*IamAccessGroupsV2) NewDeleteAssignmentOptions added in v0.44.0 

func (*IamAccessGroupsV2) NewDeleteAssignmentOptions(assignmentID string) *DeleteAssignmentOptions

NewDeleteAssignmentOptions : Instantiate DeleteAssignmentOptions

func (*IamAccessGroupsV2) NewDeleteTemplateOptions added in v0.44.0 

func (*IamAccessGroupsV2) NewDeleteTemplateOptions(templateID string) *DeleteTemplateOptions

NewDeleteTemplateOptions : Instantiate DeleteTemplateOptions

func (*IamAccessGroupsV2) NewDeleteTemplateVersionOptions added in v0.44.0 

func (*IamAccessGroupsV2) NewDeleteTemplateVersionOptions(templateID string, versionNum string) *DeleteTemplateVersionOptions

NewDeleteTemplateVersionOptions : Instantiate DeleteTemplateVersionOptions

func (*IamAccessGroupsV2) NewGetAccessGroupOptions 

func (*IamAccessGroupsV2) NewGetAccessGroupOptions(accessGroupID string) *GetAccessGroupOptions

NewGetAccessGroupOptions : Instantiate GetAccessGroupOptions

func (*IamAccessGroupsV2) NewGetAccessGroupRuleOptions 

func (*IamAccessGroupsV2) NewGetAccessGroupRuleOptions(accessGroupID string, ruleID string) *GetAccessGroupRuleOptions

NewGetAccessGroupRuleOptions : Instantiate GetAccessGroupRuleOptions

func (*IamAccessGroupsV2) NewGetAccountSettingsOptions 

func (*IamAccessGroupsV2) NewGetAccountSettingsOptions(accountID string) *GetAccountSettingsOptions

NewGetAccountSettingsOptions : Instantiate GetAccountSettingsOptions

func (*IamAccessGroupsV2) NewGetAssignmentOptions added in v0.44.0 

func (*IamAccessGroupsV2) NewGetAssignmentOptions(assignmentID string) *GetAssignmentOptions

NewGetAssignmentOptions : Instantiate GetAssignmentOptions

func (*IamAccessGroupsV2) NewGetLatestTemplateVersionOptions added in v0.44.0 

func (*IamAccessGroupsV2) NewGetLatestTemplateVersionOptions(templateID string) *GetLatestTemplateVersionOptions

NewGetLatestTemplateVersionOptions : Instantiate GetLatestTemplateVersionOptions

func (*IamAccessGroupsV2) NewGetTemplateVersionOptions added in v0.44.0 

func (*IamAccessGroupsV2) NewGetTemplateVersionOptions(templateID string, versionNum string) *GetTemplateVersionOptions

NewGetTemplateVersionOptions : Instantiate GetTemplateVersionOptions

func (*IamAccessGroupsV2) NewIsMemberOfAccessGroupOptions 

func (*IamAccessGroupsV2) NewIsMemberOfAccessGroupOptions(accessGroupID string, iamID string) *IsMemberOfAccessGroupOptions

NewIsMemberOfAccessGroupOptions : Instantiate IsMemberOfAccessGroupOptions

func (*IamAccessGroupsV2) NewListAccessGroupMembersOptions 

func (*IamAccessGroupsV2) NewListAccessGroupMembersOptions(accessGroupID string) *ListAccessGroupMembersOptions

NewListAccessGroupMembersOptions : Instantiate ListAccessGroupMembersOptions

func (*IamAccessGroupsV2) NewListAccessGroupRulesOptions 

func (*IamAccessGroupsV2) NewListAccessGroupRulesOptions(accessGroupID string) *ListAccessGroupRulesOptions

NewListAccessGroupRulesOptions : Instantiate ListAccessGroupRulesOptions

func (*IamAccessGroupsV2) NewListAccessGroupsOptions 

func (*IamAccessGroupsV2) NewListAccessGroupsOptions(accountID string) *ListAccessGroupsOptions

NewListAccessGroupsOptions : Instantiate ListAccessGroupsOptions

func (*IamAccessGroupsV2) NewListAssignmentsOptions added in v0.44.0 

func (*IamAccessGroupsV2) NewListAssignmentsOptions(accountID string) *ListAssignmentsOptions

NewListAssignmentsOptions : Instantiate ListAssignmentsOptions

func (*IamAccessGroupsV2) NewListTemplateVersionsOptions added in v0.44.0 

func (*IamAccessGroupsV2) NewListTemplateVersionsOptions(templateID string) *ListTemplateVersionsOptions

NewListTemplateVersionsOptions : Instantiate ListTemplateVersionsOptions

func (*IamAccessGroupsV2) NewListTemplatesOptions added in v0.44.0 

func (*IamAccessGroupsV2) NewListTemplatesOptions(accountID string) *ListTemplatesOptions

NewListTemplatesOptions : Instantiate ListTemplatesOptions

func (*IamAccessGroupsV2) NewRemoveAccessGroupRuleOptions 

func (*IamAccessGroupsV2) NewRemoveAccessGroupRuleOptions(accessGroupID string, ruleID string) *RemoveAccessGroupRuleOptions

NewRemoveAccessGroupRuleOptions : Instantiate RemoveAccessGroupRuleOptions

func (*IamAccessGroupsV2) NewRemoveMemberFromAccessGroupOptions 

func (*IamAccessGroupsV2) NewRemoveMemberFromAccessGroupOptions(accessGroupID string, iamID string) *RemoveMemberFromAccessGroupOptions

NewRemoveMemberFromAccessGroupOptions : Instantiate RemoveMemberFromAccessGroupOptions

func (*IamAccessGroupsV2) NewRemoveMemberFromAllAccessGroupsOptions 

func (*IamAccessGroupsV2) NewRemoveMemberFromAllAccessGroupsOptions(accountID string, iamID string) *RemoveMemberFromAllAccessGroupsOptions

NewRemoveMemberFromAllAccessGroupsOptions : Instantiate RemoveMemberFromAllAccessGroupsOptions

func (*IamAccessGroupsV2) NewRemoveMembersFromAccessGroupOptions 

func (*IamAccessGroupsV2) NewRemoveMembersFromAccessGroupOptions(accessGroupID string) *RemoveMembersFromAccessGroupOptions

NewRemoveMembersFromAccessGroupOptions : Instantiate RemoveMembersFromAccessGroupOptions

func (*IamAccessGroupsV2) NewReplaceAccessGroupRuleOptions 

func (*IamAccessGroupsV2) NewReplaceAccessGroupRuleOptions(accessGroupID string, ruleID string, ifMatch string, expiration int64, realmName string, conditions []RuleConditions) *ReplaceAccessGroupRuleOptions

NewReplaceAccessGroupRuleOptions : Instantiate ReplaceAccessGroupRuleOptions

func (*IamAccessGroupsV2) NewRuleConditions 

func (*IamAccessGroupsV2) NewRuleConditions(claim string, operator string, value string) (_model *RuleConditions, err error)

NewRuleConditions : Instantiate RuleConditions (Generic Model Constructor)

func (*IamAccessGroupsV2) NewTemplateVersionsPager added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) NewTemplateVersionsPager(options *ListTemplateVersionsOptions) (pager *TemplateVersionsPager, err error)

NewTemplateVersionsPager returns a new TemplateVersionsPager instance.

func (*IamAccessGroupsV2) NewTemplatesPager added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) NewTemplatesPager(options *ListTemplatesOptions) (pager *TemplatesPager, err error)

NewTemplatesPager returns a new TemplatesPager instance.

func (*IamAccessGroupsV2) NewUpdateAccessGroupOptions 

func (*IamAccessGroupsV2) NewUpdateAccessGroupOptions(accessGroupID string, ifMatch string) *UpdateAccessGroupOptions

NewUpdateAccessGroupOptions : Instantiate UpdateAccessGroupOptions

func (*IamAccessGroupsV2) NewUpdateAccountSettingsOptions 

func (*IamAccessGroupsV2) NewUpdateAccountSettingsOptions(accountID string) *UpdateAccountSettingsOptions

NewUpdateAccountSettingsOptions : Instantiate UpdateAccountSettingsOptions

func (*IamAccessGroupsV2) NewUpdateAssignmentOptions added in v0.44.0 

func (*IamAccessGroupsV2) NewUpdateAssignmentOptions(assignmentID string, ifMatch string, templateVersion string) *UpdateAssignmentOptions

NewUpdateAssignmentOptions : Instantiate UpdateAssignmentOptions

func (*IamAccessGroupsV2) NewUpdateTemplateVersionOptions added in v0.44.0 

func (*IamAccessGroupsV2) NewUpdateTemplateVersionOptions(templateID string, versionNum string, ifMatch string) *UpdateTemplateVersionOptions

NewUpdateTemplateVersionOptions : Instantiate UpdateTemplateVersionOptions

func (*IamAccessGroupsV2) RemoveAccessGroupRule 

func (iamAccessGroups *IamAccessGroupsV2) RemoveAccessGroupRule(removeAccessGroupRuleOptions *RemoveAccessGroupRuleOptions) (response *core.DetailedResponse, err error)

RemoveAccessGroupRule : Delete an access group rule 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.

func (*IamAccessGroupsV2) RemoveAccessGroupRuleWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) RemoveAccessGroupRuleWithContext(ctx context.Context, removeAccessGroupRuleOptions *RemoveAccessGroupRuleOptions) (response *core.DetailedResponse, err error)

RemoveAccessGroupRuleWithContext is an alternate form of the RemoveAccessGroupRule method which supports a Context parameter

func (*IamAccessGroupsV2) RemoveMemberFromAccessGroup 

func (iamAccessGroups *IamAccessGroupsV2) RemoveMemberFromAccessGroup(removeMemberFromAccessGroupOptions *RemoveMemberFromAccessGroupOptions) (response *core.DetailedResponse, err error)

RemoveMemberFromAccessGroup : Delete member from an access group 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.

func (*IamAccessGroupsV2) RemoveMemberFromAccessGroupWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) RemoveMemberFromAccessGroupWithContext(ctx context.Context, removeMemberFromAccessGroupOptions *RemoveMemberFromAccessGroupOptions) (response *core.DetailedResponse, err error)

RemoveMemberFromAccessGroupWithContext is an alternate form of the RemoveMemberFromAccessGroup method which supports a Context parameter

func (*IamAccessGroupsV2) RemoveMemberFromAllAccessGroups 

func (iamAccessGroups *IamAccessGroupsV2) RemoveMemberFromAllAccessGroups(removeMemberFromAllAccessGroupsOptions *RemoveMemberFromAllAccessGroupsOptions) (result *DeleteFromAllGroupsResponse, response *core.DetailedResponse, err error)

RemoveMemberFromAllAccessGroups : Delete member from all access groups 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.

func (*IamAccessGroupsV2) RemoveMemberFromAllAccessGroupsWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) RemoveMemberFromAllAccessGroupsWithContext(ctx context.Context, removeMemberFromAllAccessGroupsOptions *RemoveMemberFromAllAccessGroupsOptions) (result *DeleteFromAllGroupsResponse, response *core.DetailedResponse, err error)

RemoveMemberFromAllAccessGroupsWithContext is an alternate form of the RemoveMemberFromAllAccessGroups method which supports a Context parameter

func (*IamAccessGroupsV2) RemoveMembersFromAccessGroup 

func (iamAccessGroups *IamAccessGroupsV2) RemoveMembersFromAccessGroup(removeMembersFromAccessGroupOptions *RemoveMembersFromAccessGroupOptions) (result *DeleteGroupBulkMembersResponse, response *core.DetailedResponse, err error)

RemoveMembersFromAccessGroup : Delete members from an access group 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.

func (*IamAccessGroupsV2) RemoveMembersFromAccessGroupWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) RemoveMembersFromAccessGroupWithContext(ctx context.Context, removeMembersFromAccessGroupOptions *RemoveMembersFromAccessGroupOptions) (result *DeleteGroupBulkMembersResponse, response *core.DetailedResponse, err error)

RemoveMembersFromAccessGroupWithContext is an alternate form of the RemoveMembersFromAccessGroup method which supports a Context parameter

func (*IamAccessGroupsV2) ReplaceAccessGroupRule 

func (iamAccessGroups *IamAccessGroupsV2) ReplaceAccessGroupRule(replaceAccessGroupRuleOptions *ReplaceAccessGroupRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

ReplaceAccessGroupRule : Replace an access group rule 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).

func (*IamAccessGroupsV2) ReplaceAccessGroupRuleWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) ReplaceAccessGroupRuleWithContext(ctx context.Context, replaceAccessGroupRuleOptions *ReplaceAccessGroupRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

ReplaceAccessGroupRuleWithContext is an alternate form of the ReplaceAccessGroupRule method which supports a Context parameter

func (*IamAccessGroupsV2) SetDefaultHeaders added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*IamAccessGroupsV2) SetEnableGzipCompression added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*IamAccessGroupsV2) SetServiceURL 

func (iamAccessGroups *IamAccessGroupsV2) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*IamAccessGroupsV2) UpdateAccessGroup 

func (iamAccessGroups *IamAccessGroupsV2) UpdateAccessGroup(updateAccessGroupOptions *UpdateAccessGroupOptions) (result *Group, response *core.DetailedResponse, err error)

UpdateAccessGroup : Update an access group 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).

func (*IamAccessGroupsV2) UpdateAccessGroupWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) UpdateAccessGroupWithContext(ctx context.Context, updateAccessGroupOptions *UpdateAccessGroupOptions) (result *Group, response *core.DetailedResponse, err error)

UpdateAccessGroupWithContext is an alternate form of the UpdateAccessGroup method which supports a Context parameter

func (*IamAccessGroupsV2) UpdateAccountSettings 

func (iamAccessGroups *IamAccessGroupsV2) UpdateAccountSettings(updateAccountSettingsOptions *UpdateAccountSettingsOptions) (result *AccountSettings, response *core.DetailedResponse, err error)

UpdateAccountSettings : Update account 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.

func (*IamAccessGroupsV2) UpdateAccountSettingsWithContext added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) UpdateAccountSettingsWithContext(ctx context.Context, updateAccountSettingsOptions *UpdateAccountSettingsOptions) (result *AccountSettings, response *core.DetailedResponse, err error)

UpdateAccountSettingsWithContext is an alternate form of the UpdateAccountSettings method which supports a Context parameter

func (*IamAccessGroupsV2) UpdateAssignment added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) UpdateAssignment(updateAssignmentOptions *UpdateAssignmentOptions) (result *TemplateAssignmentVerboseResponse, response *core.DetailedResponse, err error)

UpdateAssignment : Update Assignment Endpoint to update template assignment.

func (*IamAccessGroupsV2) UpdateAssignmentWithContext added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) UpdateAssignmentWithContext(ctx context.Context, updateAssignmentOptions *UpdateAssignmentOptions) (result *TemplateAssignmentVerboseResponse, response *core.DetailedResponse, err error)

UpdateAssignmentWithContext is an alternate form of the UpdateAssignment method which supports a Context parameter

func (*IamAccessGroupsV2) UpdateTemplateVersion added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) UpdateTemplateVersion(updateTemplateVersionOptions *UpdateTemplateVersionOptions) (result *TemplateVersionResponse, response *core.DetailedResponse, err error)

UpdateTemplateVersion : Update template version 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.

func (*IamAccessGroupsV2) UpdateTemplateVersionWithContext added in v0.44.0 

func (iamAccessGroups *IamAccessGroupsV2) UpdateTemplateVersionWithContext(ctx context.Context, updateTemplateVersionOptions *UpdateTemplateVersionOptions) (result *TemplateVersionResponse, response *core.DetailedResponse, err error)

UpdateTemplateVersionWithContext is an alternate form of the UpdateTemplateVersion method which supports a Context parameter

type IamAccessGroupsV2Options 

type IamAccessGroupsV2Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

IamAccessGroupsV2Options : Service options

type IsMemberOfAccessGroupOptions 

type IsMemberOfAccessGroupOptions struct {
	// The access group identifier.
	AccessGroupID *string `json:"access_group_id" validate:"required,ne="`

	// The IAM identifier.
	IamID *string `json:"iam_id" validate:"required,ne="`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

IsMemberOfAccessGroupOptions : The IsMemberOfAccessGroup options.

func (*IsMemberOfAccessGroupOptions) SetAccessGroupID 

func (_options *IsMemberOfAccessGroupOptions) SetAccessGroupID(accessGroupID string) *IsMemberOfAccessGroupOptions

SetAccessGroupID : Allow user to set AccessGroupID

func (*IsMemberOfAccessGroupOptions) SetHeaders 

func (options *IsMemberOfAccessGroupOptions) SetHeaders(param map[string]string) *IsMemberOfAccessGroupOptions

SetHeaders : Allow user to set Headers

func (*IsMemberOfAccessGroupOptions) SetIamID 

func (_options *IsMemberOfAccessGroupOptions) SetIamID(iamID string) *IsMemberOfAccessGroupOptions

SetIamID : Allow user to set IamID

func (*IsMemberOfAccessGroupOptions) SetTransactionID 

func (_options *IsMemberOfAccessGroupOptions) SetTransactionID(transactionID string) *IsMemberOfAccessGroupOptions

SetTransactionID : Allow user to set TransactionID

type ListAccessGroupMembersOptions 

type ListAccessGroupMembersOptions struct {
	// The access group identifier.
	AccessGroupID *string `json:"access_group_id" validate:"required,ne="`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// 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.
	MembershipType *string `json:"membership_type,omitempty"`

	// Return up to this limit of results where limit is between 0 and 100.
	Limit *int64 `json:"limit,omitempty"`

	// The offset of the first result item to be returned.
	Offset *int64 `json:"offset,omitempty"`

	// Filter the results by member type.
	Type *string `json:"type,omitempty"`

	// Return user's email and name for each user ID or the name for each service ID or trusted profile.
	Verbose *bool `json:"verbose,omitempty"`

	// If verbose is true, sort the results by id, name, or email.
	Sort *string `json:"sort,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListAccessGroupMembersOptions : The ListAccessGroupMembers options.

func (*ListAccessGroupMembersOptions) SetAccessGroupID 

func (_options *ListAccessGroupMembersOptions) SetAccessGroupID(accessGroupID string) *ListAccessGroupMembersOptions

SetAccessGroupID : Allow user to set AccessGroupID

func (*ListAccessGroupMembersOptions) SetHeaders 

func (options *ListAccessGroupMembersOptions) SetHeaders(param map[string]string) *ListAccessGroupMembersOptions

SetHeaders : Allow user to set Headers

func (*ListAccessGroupMembersOptions) SetLimit 

func (_options *ListAccessGroupMembersOptions) SetLimit(limit int64) *ListAccessGroupMembersOptions

SetLimit : Allow user to set Limit

func (*ListAccessGroupMembersOptions) SetMembershipType added in v0.23.0 

func (_options *ListAccessGroupMembersOptions) SetMembershipType(membershipType string) *ListAccessGroupMembersOptions

SetMembershipType : Allow user to set MembershipType

func (*ListAccessGroupMembersOptions) SetOffset 

func (_options *ListAccessGroupMembersOptions) SetOffset(offset int64) *ListAccessGroupMembersOptions

SetOffset : Allow user to set Offset

func (*ListAccessGroupMembersOptions) SetSort 

func (_options *ListAccessGroupMembersOptions) SetSort(sort string) *ListAccessGroupMembersOptions

SetSort : Allow user to set Sort

func (*ListAccessGroupMembersOptions) SetTransactionID 

func (_options *ListAccessGroupMembersOptions) SetTransactionID(transactionID string) *ListAccessGroupMembersOptions

SetTransactionID : Allow user to set TransactionID

func (*ListAccessGroupMembersOptions) SetType 

func (_options *ListAccessGroupMembersOptions) SetType(typeVar string) *ListAccessGroupMembersOptions

SetType : Allow user to set Type

func (*ListAccessGroupMembersOptions) SetVerbose 

func (_options *ListAccessGroupMembersOptions) SetVerbose(verbose bool) *ListAccessGroupMembersOptions

SetVerbose : Allow user to set Verbose

type ListAccessGroupRulesOptions 

type ListAccessGroupRulesOptions struct {
	// The access group identifier.
	AccessGroupID *string `json:"access_group_id" validate:"required,ne="`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListAccessGroupRulesOptions : The ListAccessGroupRules options.

func (*ListAccessGroupRulesOptions) SetAccessGroupID 

func (_options *ListAccessGroupRulesOptions) SetAccessGroupID(accessGroupID string) *ListAccessGroupRulesOptions

SetAccessGroupID : Allow user to set AccessGroupID

func (*ListAccessGroupRulesOptions) SetHeaders 

func (options *ListAccessGroupRulesOptions) SetHeaders(param map[string]string) *ListAccessGroupRulesOptions

SetHeaders : Allow user to set Headers

func (*ListAccessGroupRulesOptions) SetTransactionID 

func (_options *ListAccessGroupRulesOptions) SetTransactionID(transactionID string) *ListAccessGroupRulesOptions

SetTransactionID : Allow user to set TransactionID

type ListAccessGroupsOptions 

type ListAccessGroupsOptions struct {
	// 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.
	AccountID *string `json:"account_id" validate:"required"`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Return groups for member ID (IBMid, service ID or trusted profile ID).
	IamID *string `json:"iam_id,omitempty"`

	// 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.
	Search *string `json:"search,omitempty"`

	// 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.
	MembershipType *string `json:"membership_type,omitempty"`

	// Return up to this limit of results where limit is between 0 and 100.
	Limit *int64 `json:"limit,omitempty"`

	// The offset of the first result item to be returned.
	Offset *int64 `json:"offset,omitempty"`

	// Sort the results by id, name, description, or is_federated flag.
	Sort *string `json:"sort,omitempty"`

	// 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.
	ShowFederated *bool `json:"show_federated,omitempty"`

	// If hide_public_access is true, do not include the Public Access Group in the results.
	HidePublicAccess *bool `json:"hide_public_access,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListAccessGroupsOptions : The ListAccessGroups options.

func (*ListAccessGroupsOptions) SetAccountID 

func (_options *ListAccessGroupsOptions) SetAccountID(accountID string) *ListAccessGroupsOptions

SetAccountID : Allow user to set AccountID

func (*ListAccessGroupsOptions) SetHeaders 

func (options *ListAccessGroupsOptions) SetHeaders(param map[string]string) *ListAccessGroupsOptions

SetHeaders : Allow user to set Headers

func (*ListAccessGroupsOptions) SetHidePublicAccess 

func (_options *ListAccessGroupsOptions) SetHidePublicAccess(hidePublicAccess bool) *ListAccessGroupsOptions

SetHidePublicAccess : Allow user to set HidePublicAccess

func (*ListAccessGroupsOptions) SetIamID 

func (_options *ListAccessGroupsOptions) SetIamID(iamID string) *ListAccessGroupsOptions

SetIamID : Allow user to set IamID

func (*ListAccessGroupsOptions) SetLimit 

func (_options *ListAccessGroupsOptions) SetLimit(limit int64) *ListAccessGroupsOptions

SetLimit : Allow user to set Limit

func (*ListAccessGroupsOptions) SetMembershipType added in v0.23.0 

func (_options *ListAccessGroupsOptions) SetMembershipType(membershipType string) *ListAccessGroupsOptions

SetMembershipType : Allow user to set MembershipType

func (*ListAccessGroupsOptions) SetOffset 

func (_options *ListAccessGroupsOptions) SetOffset(offset int64) *ListAccessGroupsOptions

SetOffset : Allow user to set Offset

func (*ListAccessGroupsOptions) SetSearch added in v0.44.0 

func (_options *ListAccessGroupsOptions) SetSearch(search string) *ListAccessGroupsOptions

SetSearch : Allow user to set Search

func (*ListAccessGroupsOptions) SetShowFederated 

func (_options *ListAccessGroupsOptions) SetShowFederated(showFederated bool) *ListAccessGroupsOptions

SetShowFederated : Allow user to set ShowFederated

func (*ListAccessGroupsOptions) SetSort 

func (_options *ListAccessGroupsOptions) SetSort(sort string) *ListAccessGroupsOptions

SetSort : Allow user to set Sort

func (*ListAccessGroupsOptions) SetTransactionID 

func (_options *ListAccessGroupsOptions) SetTransactionID(transactionID string) *ListAccessGroupsOptions

SetTransactionID : Allow user to set TransactionID

type ListAssignmentsOptions added in v0.44.0 

type ListAssignmentsOptions struct {
	// Enterprise account ID.
	AccountID *string `json:"account_id" validate:"required"`

	// Filter results by Template Id.
	TemplateID *string `json:"template_id,omitempty"`

	// Filter results by Template Version.
	TemplateVersion *string `json:"template_version,omitempty"`

	// Filter results by the assignment target.
	Target *string `json:"target,omitempty"`

	// Filter results by the assignment status.
	Status *string `json:"status,omitempty"`

	// An optional transaction id for the request.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Return up to this limit of results where limit is between 0 and 100.
	Limit *int64 `json:"limit,omitempty"`

	// The offset of the first result item to be returned.
	Offset *int64 `json:"offset,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListAssignmentsOptions : The ListAssignments options.

func (*ListAssignmentsOptions) SetAccountID added in v0.44.0 

func (_options *ListAssignmentsOptions) SetAccountID(accountID string) *ListAssignmentsOptions

SetAccountID : Allow user to set AccountID

func (*ListAssignmentsOptions) SetHeaders added in v0.44.0 

func (options *ListAssignmentsOptions) SetHeaders(param map[string]string) *ListAssignmentsOptions

SetHeaders : Allow user to set Headers

func (*ListAssignmentsOptions) SetLimit added in v0.44.0 

func (_options *ListAssignmentsOptions) SetLimit(limit int64) *ListAssignmentsOptions

SetLimit : Allow user to set Limit

func (*ListAssignmentsOptions) SetOffset added in v0.44.0 

func (_options *ListAssignmentsOptions) SetOffset(offset int64) *ListAssignmentsOptions

SetOffset : Allow user to set Offset

func (*ListAssignmentsOptions) SetStatus added in v0.44.0 

func (_options *ListAssignmentsOptions) SetStatus(status string) *ListAssignmentsOptions

SetStatus : Allow user to set Status

func (*ListAssignmentsOptions) SetTarget added in v0.44.0 

func (_options *ListAssignmentsOptions) SetTarget(target string) *ListAssignmentsOptions

SetTarget : Allow user to set Target

func (*ListAssignmentsOptions) SetTemplateID added in v0.44.0 

func (_options *ListAssignmentsOptions) SetTemplateID(templateID string) *ListAssignmentsOptions

SetTemplateID : Allow user to set TemplateID

func (*ListAssignmentsOptions) SetTemplateVersion added in v0.44.0 

func (_options *ListAssignmentsOptions) SetTemplateVersion(templateVersion string) *ListAssignmentsOptions

SetTemplateVersion : Allow user to set TemplateVersion

func (*ListAssignmentsOptions) SetTransactionID added in v0.44.0 

func (_options *ListAssignmentsOptions) SetTransactionID(transactionID string) *ListAssignmentsOptions

SetTransactionID : Allow user to set TransactionID

type ListGroupMembersResponseMember 

type ListGroupMembersResponseMember struct {
	// The IBMid or Service Id of the member.
	IamID *string `json:"iam_id,omitempty"`

	// The member type - either `user`, `service` or `profile`.
	Type *string `json:"type,omitempty"`

	// The membership type - either `static` or `dynamic`.
	MembershipType *string `json:"membership_type,omitempty"`

	// The user's or service id's name.
	Name *string `json:"name,omitempty"`

	// If the member type is user, this is the user's email.
	Email *string `json:"email,omitempty"`

	// If the member type is service, this is the service id's description.
	Description *string `json:"description,omitempty"`

	// A url to the given member resource.
	Href *string `json:"href,omitempty"`

	// The timestamp the membership was created at.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The `iam_id` of the entity that created the membership.
	CreatedByID *string `json:"created_by_id,omitempty"`
}

ListGroupMembersResponseMember : A single member of an access group in a list.

type ListTemplateAssignmentResponse added in v0.44.0 

type ListTemplateAssignmentResponse struct {
	// Maximum number of items returned in the response.
	Limit *int64 `json:"limit" validate:"required"`

	// Index of the first item returned in the response.
	Offset *int64 `json:"offset" validate:"required"`

	// Total number of items matching the query.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// A link object.
	First *HrefStruct `json:"first" validate:"required"`

	// A link object.
	Last *HrefStruct `json:"last" validate:"required"`

	// List of template assignments.
	Assignments []TemplateAssignmentResponse `json:"assignments" validate:"required"`
}

ListTemplateAssignmentResponse : Response object containing a list of template assignments.

type ListTemplateVersionResponse added in v0.44.0 

type ListTemplateVersionResponse struct {
	// The name of the template.
	Name *string `json:"name" validate:"required"`

	// The description of the template.
	Description *string `json:"description" validate:"required"`

	// The ID of the account associated with the template.
	AccountID *string `json:"account_id" validate:"required"`

	// The version number of the template.
	Version *string `json:"version" validate:"required"`

	// A boolean indicating whether the template is committed or not.
	Committed *bool `json:"committed" validate:"required"`

	// Access Group Component.
	Group *AccessGroupResponse `json:"group" validate:"required"`

	// A list of policy templates associated with the template.
	PolicyTemplateReferences []PolicyTemplates `json:"policy_template_references" validate:"required"`

	// The URL to the template resource.
	Href *string `json:"href" validate:"required"`

	// The date and time the template was created.
	CreatedAt *string `json:"created_at" validate:"required"`

	// The ID of the user who created the template.
	CreatedByID *string `json:"created_by_id" validate:"required"`

	// The date and time the template was last modified.
	LastModifiedAt *string `json:"last_modified_at" validate:"required"`

	// The ID of the user who last modified the template.
	LastModifiedByID *string `json:"last_modified_by_id" validate:"required"`
}

ListTemplateVersionResponse : Response object for a single access group template version.

type ListTemplateVersionsOptions added in v0.44.0 

type ListTemplateVersionsOptions struct {
	// ID of the template that you want to list all versions of.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// Return up to this limit of results where limit is between 0 and 100.
	Limit *int64 `json:"limit,omitempty"`

	// The offset of the first result item to be returned.
	Offset *int64 `json:"offset,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListTemplateVersionsOptions : The ListTemplateVersions options.

func (*ListTemplateVersionsOptions) SetHeaders added in v0.44.0 

func (options *ListTemplateVersionsOptions) SetHeaders(param map[string]string) *ListTemplateVersionsOptions

SetHeaders : Allow user to set Headers

func (*ListTemplateVersionsOptions) SetLimit added in v0.44.0 

func (_options *ListTemplateVersionsOptions) SetLimit(limit int64) *ListTemplateVersionsOptions

SetLimit : Allow user to set Limit

func (*ListTemplateVersionsOptions) SetOffset added in v0.44.0 

func (_options *ListTemplateVersionsOptions) SetOffset(offset int64) *ListTemplateVersionsOptions

SetOffset : Allow user to set Offset

func (*ListTemplateVersionsOptions) SetTemplateID added in v0.44.0 

func (_options *ListTemplateVersionsOptions) SetTemplateID(templateID string) *ListTemplateVersionsOptions

SetTemplateID : Allow user to set TemplateID

type ListTemplateVersionsResponse added in v0.44.0 

type ListTemplateVersionsResponse struct {
	// The maximum number of IAM resources to return.
	Limit *int64 `json:"limit" validate:"required"`

	// The offset of the first IAM resource in the list.
	Offset *int64 `json:"offset" validate:"required"`

	// The total number of IAM resources in the list.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// A link object.
	First *HrefStruct `json:"first" validate:"required"`

	// A link object.
	Previous *HrefStruct `json:"previous,omitempty"`

	// A link object.
	Next *HrefStruct `json:"next,omitempty"`

	// A link object.
	Last *HrefStruct `json:"last" validate:"required"`

	// A list of access group template versions.
	GroupTemplateVersions []ListTemplateVersionResponse `json:"group_template_versions" validate:"required"`
}

ListTemplateVersionsResponse : Response object for listing template versions.

func (*ListTemplateVersionsResponse) GetNextOffset added in v0.44.0 

func (resp *ListTemplateVersionsResponse) GetNextOffset() (*int64, error)

Retrieve the value to be passed to a request to access the next page of results

type ListTemplatesOptions added in v0.44.0 

type ListTemplatesOptions struct {
	// Enterprise account ID.
	AccountID *string `json:"account_id" validate:"required"`

	// An optional transaction id for the request.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Return up to this limit of results where limit is between 0 and 100.
	Limit *int64 `json:"limit,omitempty"`

	// The offset of the first result item to be returned.
	Offset *int64 `json:"offset,omitempty"`

	// If `verbose=true`, IAM resource details are returned. If performance is a concern, leave the `verbose` parameter off
	// so that details are not retrieved.
	Verbose *bool `json:"verbose,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListTemplatesOptions : The ListTemplates options.

func (*ListTemplatesOptions) SetAccountID added in v0.44.0 

func (_options *ListTemplatesOptions) SetAccountID(accountID string) *ListTemplatesOptions

SetAccountID : Allow user to set AccountID

func (*ListTemplatesOptions) SetHeaders added in v0.44.0 

func (options *ListTemplatesOptions) SetHeaders(param map[string]string) *ListTemplatesOptions

SetHeaders : Allow user to set Headers

func (*ListTemplatesOptions) SetLimit added in v0.44.0 

func (_options *ListTemplatesOptions) SetLimit(limit int64) *ListTemplatesOptions

SetLimit : Allow user to set Limit

func (*ListTemplatesOptions) SetOffset added in v0.44.0 

func (_options *ListTemplatesOptions) SetOffset(offset int64) *ListTemplatesOptions

SetOffset : Allow user to set Offset

func (*ListTemplatesOptions) SetTransactionID added in v0.44.0 

func (_options *ListTemplatesOptions) SetTransactionID(transactionID string) *ListTemplatesOptions

SetTransactionID : Allow user to set TransactionID

func (*ListTemplatesOptions) SetVerbose added in v0.44.0 

func (_options *ListTemplatesOptions) SetVerbose(verbose bool) *ListTemplatesOptions

SetVerbose : Allow user to set Verbose

type ListTemplatesResponse added in v0.44.0 

type ListTemplatesResponse struct {
	// The maximum number of IAM resources to return.
	Limit *int64 `json:"limit" validate:"required"`

	// The offset of the first IAM resource in the list.
	Offset *int64 `json:"offset" validate:"required"`

	// The total number of IAM resources in the list.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// A link object.
	First *HrefStruct `json:"first" validate:"required"`

	// A link object.
	Previous *HrefStruct `json:"previous,omitempty"`

	// A link object.
	Next *HrefStruct `json:"next,omitempty"`

	// A link object.
	Last *HrefStruct `json:"last" validate:"required"`

	// A list of access group templates.
	GroupTemplates []GroupTemplate `json:"group_templates" validate:"required"`
}

ListTemplatesResponse : Response object for listing templates.

func (*ListTemplatesResponse) GetNextOffset added in v0.44.0 

func (resp *ListTemplatesResponse) GetNextOffset() (*int64, error)

Retrieve the value to be passed to a request to access the next page of results

type Members added in v0.44.0 

type Members struct {
	// 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.
	Users []string `json:"users,omitempty"`

	// Array of service IDs to add to the template.
	Services []string `json:"services,omitempty"`

	// Control whether or not access group administrators in child accounts can add and remove members from the
	// enterprise-managed access group in their account.
	ActionControls *MembersActionControls `json:"action_controls,omitempty"`
}

Members : 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.

type MembersActionControls added in v0.44.0 

type MembersActionControls struct {
	// Action control for adding child account members to an enterprise-managed access group. If an access group
	// administrator in a child account adds a member, they can always remove them. Note that if conflicts arise between an
	// update to this control in a new version and members added by an administrator in the child account, you must resolve
	// those conflicts in the child account. This prevents breaking access in the child account. For more information, see
	// [Working with versions]
	// (https://test.cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-working-with-versions#new-version-scenarios).
	Add *bool `json:"add,omitempty"`

	// Action control for removing enterprise-managed members from an enterprise-managed access group. Note that if an
	// enterprise member is removed from an enterprise-managed access group in a child account and you reassign the
	// template, the membership is reinstated.
	Remove *bool `json:"remove,omitempty"`
}

MembersActionControls : Control whether or not access group administrators in child accounts can add and remove members from the enterprise-managed access group in their account.

type PolicyTemplates added in v0.44.0 

type PolicyTemplates struct {
	// Policy template ID.
	ID *string `json:"id,omitempty"`

	// Policy template version.
	Version *string `json:"version,omitempty"`
}

PolicyTemplates : Policy Templates Input component.

type RemoveAccessGroupRuleOptions 

type RemoveAccessGroupRuleOptions struct {
	// The access group identifier.
	AccessGroupID *string `json:"access_group_id" validate:"required,ne="`

	// The rule to get.
	RuleID *string `json:"rule_id" validate:"required,ne="`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

RemoveAccessGroupRuleOptions : The RemoveAccessGroupRule options.

func (*RemoveAccessGroupRuleOptions) SetAccessGroupID 

func (_options *RemoveAccessGroupRuleOptions) SetAccessGroupID(accessGroupID string) *RemoveAccessGroupRuleOptions

SetAccessGroupID : Allow user to set AccessGroupID

func (*RemoveAccessGroupRuleOptions) SetHeaders 

func (options *RemoveAccessGroupRuleOptions) SetHeaders(param map[string]string) *RemoveAccessGroupRuleOptions

SetHeaders : Allow user to set Headers

func (*RemoveAccessGroupRuleOptions) SetRuleID 

func (_options *RemoveAccessGroupRuleOptions) SetRuleID(ruleID string) *RemoveAccessGroupRuleOptions

SetRuleID : Allow user to set RuleID

func (*RemoveAccessGroupRuleOptions) SetTransactionID 

func (_options *RemoveAccessGroupRuleOptions) SetTransactionID(transactionID string) *RemoveAccessGroupRuleOptions

SetTransactionID : Allow user to set TransactionID

type RemoveMemberFromAccessGroupOptions 

type RemoveMemberFromAccessGroupOptions struct {
	// The access group identifier.
	AccessGroupID *string `json:"access_group_id" validate:"required,ne="`

	// The IAM identifier.
	IamID *string `json:"iam_id" validate:"required,ne="`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

RemoveMemberFromAccessGroupOptions : The RemoveMemberFromAccessGroup options.

func (*RemoveMemberFromAccessGroupOptions) SetAccessGroupID 

func (_options *RemoveMemberFromAccessGroupOptions) SetAccessGroupID(accessGroupID string) *RemoveMemberFromAccessGroupOptions

SetAccessGroupID : Allow user to set AccessGroupID

func (*RemoveMemberFromAccessGroupOptions) SetHeaders 

func (options *RemoveMemberFromAccessGroupOptions) SetHeaders(param map[string]string) *RemoveMemberFromAccessGroupOptions

SetHeaders : Allow user to set Headers

func (*RemoveMemberFromAccessGroupOptions) SetIamID 

func (_options *RemoveMemberFromAccessGroupOptions) SetIamID(iamID string) *RemoveMemberFromAccessGroupOptions

SetIamID : Allow user to set IamID

func (*RemoveMemberFromAccessGroupOptions) SetTransactionID 

func (_options *RemoveMemberFromAccessGroupOptions) SetTransactionID(transactionID string) *RemoveMemberFromAccessGroupOptions

SetTransactionID : Allow user to set TransactionID

type RemoveMemberFromAllAccessGroupsOptions 

type RemoveMemberFromAllAccessGroupsOptions struct {
	// 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.
	AccountID *string `json:"account_id" validate:"required"`

	// The IAM identifier.
	IamID *string `json:"iam_id" validate:"required,ne="`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

RemoveMemberFromAllAccessGroupsOptions : The RemoveMemberFromAllAccessGroups options.

func (*RemoveMemberFromAllAccessGroupsOptions) SetAccountID 

func (_options *RemoveMemberFromAllAccessGroupsOptions) SetAccountID(accountID string) *RemoveMemberFromAllAccessGroupsOptions

SetAccountID : Allow user to set AccountID

func (*RemoveMemberFromAllAccessGroupsOptions) SetHeaders 

func (options *RemoveMemberFromAllAccessGroupsOptions) SetHeaders(param map[string]string) *RemoveMemberFromAllAccessGroupsOptions

SetHeaders : Allow user to set Headers

func (*RemoveMemberFromAllAccessGroupsOptions) SetIamID 

func (_options *RemoveMemberFromAllAccessGroupsOptions) SetIamID(iamID string) *RemoveMemberFromAllAccessGroupsOptions

SetIamID : Allow user to set IamID

func (*RemoveMemberFromAllAccessGroupsOptions) SetTransactionID 

func (_options *RemoveMemberFromAllAccessGroupsOptions) SetTransactionID(transactionID string) *RemoveMemberFromAllAccessGroupsOptions

SetTransactionID : Allow user to set TransactionID

type RemoveMembersFromAccessGroupOptions 

type RemoveMembersFromAccessGroupOptions struct {
	// The access group identifier.
	AccessGroupID *string `json:"access_group_id" validate:"required,ne="`

	// The `iam_id`s to remove from the access group. This field has a limit of 50 `iam_id`s.
	Members []string `json:"members,omitempty"`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

RemoveMembersFromAccessGroupOptions : The RemoveMembersFromAccessGroup options.

func (*RemoveMembersFromAccessGroupOptions) SetAccessGroupID 

func (_options *RemoveMembersFromAccessGroupOptions) SetAccessGroupID(accessGroupID string) *RemoveMembersFromAccessGroupOptions

SetAccessGroupID : Allow user to set AccessGroupID

func (*RemoveMembersFromAccessGroupOptions) SetHeaders 

func (options *RemoveMembersFromAccessGroupOptions) SetHeaders(param map[string]string) *RemoveMembersFromAccessGroupOptions

SetHeaders : Allow user to set Headers

func (*RemoveMembersFromAccessGroupOptions) SetMembers 

func (_options *RemoveMembersFromAccessGroupOptions) SetMembers(members []string) *RemoveMembersFromAccessGroupOptions

SetMembers : Allow user to set Members

func (*RemoveMembersFromAccessGroupOptions) SetTransactionID 

func (_options *RemoveMembersFromAccessGroupOptions) SetTransactionID(transactionID string) *RemoveMembersFromAccessGroupOptions

SetTransactionID : Allow user to set TransactionID

type ReplaceAccessGroupRuleOptions 

type ReplaceAccessGroupRuleOptions struct {
	// The access group identifier.
	AccessGroupID *string `json:"access_group_id" validate:"required,ne="`

	// The rule to get.
	RuleID *string `json:"rule_id" validate:"required,ne="`

	// The current revision number of the rule being updated. This can be found in the Get Rule response ETag header.
	IfMatch *string `json:"If-Match" validate:"required"`

	// 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.
	Expiration *int64 `json:"expiration" validate:"required"`

	// The URL of the identity provider (IdP).
	RealmName *string `json:"realm_name" validate:"required"`

	// A list of conditions that identities must satisfy to gain access group membership.
	Conditions []RuleConditions `json:"conditions" validate:"required"`

	// The name of the dynaimic rule.
	Name *string `json:"name,omitempty"`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ReplaceAccessGroupRuleOptions : The ReplaceAccessGroupRule options.

func (*ReplaceAccessGroupRuleOptions) SetAccessGroupID 

func (_options *ReplaceAccessGroupRuleOptions) SetAccessGroupID(accessGroupID string) *ReplaceAccessGroupRuleOptions

SetAccessGroupID : Allow user to set AccessGroupID

func (*ReplaceAccessGroupRuleOptions) SetConditions 

func (_options *ReplaceAccessGroupRuleOptions) SetConditions(conditions []RuleConditions) *ReplaceAccessGroupRuleOptions

SetConditions : Allow user to set Conditions

func (*ReplaceAccessGroupRuleOptions) SetExpiration 

func (_options *ReplaceAccessGroupRuleOptions) SetExpiration(expiration int64) *ReplaceAccessGroupRuleOptions

SetExpiration : Allow user to set Expiration

func (*ReplaceAccessGroupRuleOptions) SetHeaders 

func (options *ReplaceAccessGroupRuleOptions) SetHeaders(param map[string]string) *ReplaceAccessGroupRuleOptions

SetHeaders : Allow user to set Headers

func (*ReplaceAccessGroupRuleOptions) SetIfMatch 

func (_options *ReplaceAccessGroupRuleOptions) SetIfMatch(ifMatch string) *ReplaceAccessGroupRuleOptions

SetIfMatch : Allow user to set IfMatch

func (*ReplaceAccessGroupRuleOptions) SetName 

func (_options *ReplaceAccessGroupRuleOptions) SetName(name string) *ReplaceAccessGroupRuleOptions

SetName : Allow user to set Name

func (*ReplaceAccessGroupRuleOptions) SetRealmName 

func (_options *ReplaceAccessGroupRuleOptions) SetRealmName(realmName string) *ReplaceAccessGroupRuleOptions

SetRealmName : Allow user to set RealmName

func (*ReplaceAccessGroupRuleOptions) SetRuleID 

func (_options *ReplaceAccessGroupRuleOptions) SetRuleID(ruleID string) *ReplaceAccessGroupRuleOptions

SetRuleID : Allow user to set RuleID

func (*ReplaceAccessGroupRuleOptions) SetTransactionID 

func (_options *ReplaceAccessGroupRuleOptions) SetTransactionID(transactionID string) *ReplaceAccessGroupRuleOptions

SetTransactionID : Allow user to set TransactionID

type ResourceListWithTargetAccountID added in v0.44.0 

type ResourceListWithTargetAccountID struct {
	// The ID of the entity that the resource list applies to.
	Target *string `json:"target,omitempty"`

	// Assignment Resource Access Group.
	Group *AssignmentResourceAccessGroup `json:"group,omitempty"`

	// List of policy template references for the resource list.
	PolicyTemplateReferences []AssignmentResourceEntry `json:"policy_template_references,omitempty"`
}

ResourceListWithTargetAccountID : Object containing details of a resource list with target account ID.

type Rule 

type Rule struct {
	// The rule id.
	ID *string `json:"id,omitempty"`

	// The name of the rule.
	Name *string `json:"name,omitempty"`

	// 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 between 1 and 24.
	Expiration *int64 `json:"expiration,omitempty"`

	// The URL of the identity provider.
	RealmName *string `json:"realm_name,omitempty"`

	// The group id that the dynamic rule is assigned to.
	AccessGroupID *string `json:"access_group_id,omitempty"`

	// The account id that the group is in.
	AccountID *string `json:"account_id,omitempty"`

	// A list of conditions that identities must satisfy to gain access group membership.
	Conditions []RuleConditions `json:"conditions,omitempty"`

	// The timestamp for when the rule was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The `iam_id` of the entity that created the dynamic rule.
	CreatedByID *string `json:"created_by_id,omitempty"`

	// The timestamp for when the dynamic rule was last edited.
	LastModifiedAt *strfmt.DateTime `json:"last_modified_at,omitempty"`

	// The IAM id that last modified the rule.
	LastModifiedByID *string `json:"last_modified_by_id,omitempty"`
}

Rule : A dynamic rule of an access group.

type RuleActionControls added in v0.44.0 

type RuleActionControls struct {
	// Action control for removing this enterprise-managed dynamic rule.
	Remove *bool `json:"remove,omitempty"`
}

RuleActionControls : Control whether or not access group administrators in child accounts can update and remove this dynamic rule in the enterprise-managed access group in their account.This overrides outer level AssertionsActionControls.

type RuleConditions 

type RuleConditions struct {
	// The claim to evaluate against. This will be found in the `ext` claims of a user's login request.
	Claim *string `json:"claim" validate:"required"`

	// The operation to perform on the claim.
	Operator *string `json:"operator" validate:"required"`

	// The stringified JSON value that the claim is compared to using the operator.
	Value *string `json:"value" validate:"required"`
}

RuleConditions : The conditions of a dynamic rule.

type RulesList 

type RulesList struct {
	// A list of dynamic rules.
	Rules []Rule `json:"rules,omitempty"`
}

RulesList : A list of dynamic rules attached to the access group.

type TemplateAssignmentResponse added in v0.44.0 

type TemplateAssignmentResponse struct {
	// The ID of the assignment.
	ID *string `json:"id" validate:"required"`

	// The ID of the account that the assignment belongs to.
	AccountID *string `json:"account_id" validate:"required"`

	// The ID of the template that the assignment is based on.
	TemplateID *string `json:"template_id" validate:"required"`

	// The version of the template that the assignment is based on.
	TemplateVersion *string `json:"template_version" validate:"required"`

	// The type of the entity that the assignment applies to.
	TargetType *string `json:"target_type" validate:"required"`

	// The ID of the entity that the assignment applies to.
	Target *string `json:"target" validate:"required"`

	// The operation that the assignment applies to (e.g. 'assign', 'update', 'remove').
	Operation *string `json:"operation" validate:"required"`

	// The status of the assignment (e.g. 'accepted', 'in_progress', 'succeeded', 'failed', 'superseded').
	Status *string `json:"status" validate:"required"`

	// The URL of the assignment resource.
	Href *string `json:"href" validate:"required"`

	// The date and time when the assignment was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The user or system that created the assignment.
	CreatedByID *string `json:"created_by_id" validate:"required"`

	// The date and time when the assignment was last updated.
	LastModifiedAt *strfmt.DateTime `json:"last_modified_at" validate:"required"`

	// The user or system that last updated the assignment.
	LastModifiedByID *string `json:"last_modified_by_id" validate:"required"`
}

TemplateAssignmentResponse : Response object containing the details of a template assignment.

type TemplateAssignmentVerboseResponse added in v0.44.0 

type TemplateAssignmentVerboseResponse struct {
	// The ID of the assignment.
	ID *string `json:"id" validate:"required"`

	// The ID of the account that the assignment belongs to.
	AccountID *string `json:"account_id" validate:"required"`

	// The ID of the template that the assignment is based on.
	TemplateID *string `json:"template_id" validate:"required"`

	// The version of the template that the assignment is based on.
	TemplateVersion *string `json:"template_version" validate:"required"`

	// The type of the entity that the assignment applies to.
	TargetType *string `json:"target_type" validate:"required"`

	// The ID of the entity that the assignment applies to.
	Target *string `json:"target" validate:"required"`

	// The operation that the assignment applies to (e.g. 'create', 'update', 'delete').
	Operation *string `json:"operation" validate:"required"`

	// The status of the assignment (e.g. 'pending', 'success', 'failure').
	Status *string `json:"status" validate:"required"`

	// List of resources for the assignment.
	Resources []ResourceListWithTargetAccountID `json:"resources,omitempty"`

	// The URL of the assignment resource.
	Href *string `json:"href" validate:"required"`

	// The date and time when the assignment was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The user or system that created the assignment.
	CreatedByID *string `json:"created_by_id" validate:"required"`

	// The date and time when the assignment was last updated.
	LastModifiedAt *strfmt.DateTime `json:"last_modified_at" validate:"required"`

	// The user or system that last updated the assignment.
	LastModifiedByID *string `json:"last_modified_by_id" validate:"required"`
}

TemplateAssignmentVerboseResponse : Response object containing the details of a template assignment.

type TemplateResponse added in v0.44.0 

type TemplateResponse struct {
	// The ID of the access group template.
	ID *string `json:"id" validate:"required"`

	// The name of the access group template.
	Name *string `json:"name" validate:"required"`

	// The description of the access group template.
	Description *string `json:"description" validate:"required"`

	// The ID of the account to which the access group template is assigned.
	AccountID *string `json:"account_id" validate:"required"`

	// The version of the access group template.
	Version *string `json:"version" validate:"required"`

	// A boolean indicating whether the access group template is committed. You must commit a template before you can
	// assign it to child accounts.
	Committed *bool `json:"committed" validate:"required"`

	// Access Group Component.
	Group *AccessGroupResponse `json:"group" validate:"required"`

	// References to policy templates assigned to the access group template.
	PolicyTemplateReferences []PolicyTemplates `json:"policy_template_references" validate:"required"`

	// The URL of the access group template resource.
	Href *string `json:"href" validate:"required"`

	// The date and time when the access group template was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The ID of the user who created the access group template.
	CreatedByID *string `json:"created_by_id" validate:"required"`

	// The date and time when the access group template was last modified.
	LastModifiedAt *strfmt.DateTime `json:"last_modified_at" validate:"required"`

	// The ID of the user who last modified the access group template.
	LastModifiedByID *string `json:"last_modified_by_id" validate:"required"`
}

TemplateResponse : Response output for template.

type TemplateVersionResponse added in v0.44.0 

type TemplateVersionResponse struct {
	// The ID of the access group template.
	ID *string `json:"id" validate:"required"`

	// The name of the access group template.
	Name *string `json:"name" validate:"required"`

	// The description of the access group template.
	Description *string `json:"description" validate:"required"`

	// The ID of the account to which the access group template is assigned.
	AccountID *string `json:"account_id" validate:"required"`

	// The version of the access group template.
	Version *string `json:"version" validate:"required"`

	// A boolean indicating whether the access group template is committed. You must commit a template before you can
	// assign it to child accounts.
	Committed *bool `json:"committed" validate:"required"`

	// Access Group Component.
	Group *AccessGroupResponse `json:"group" validate:"required"`

	// References to policy templates assigned to the access group template.
	PolicyTemplateReferences []PolicyTemplates `json:"policy_template_references" validate:"required"`

	// The URL of the access group template resource.
	Href *string `json:"href" validate:"required"`

	// The date and time when the access group template was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The ID of the user who created the access group template.
	CreatedByID *string `json:"created_by_id" validate:"required"`

	// The date and time when the access group template was last modified.
	LastModifiedAt *strfmt.DateTime `json:"last_modified_at" validate:"required"`

	// The ID of the user who last modified the access group template.
	LastModifiedByID *string `json:"last_modified_by_id" validate:"required"`
}

TemplateVersionResponse : Response output for template.

type TemplateVersionsPager added in v0.44.0 

type TemplateVersionsPager struct {
	// contains filtered or unexported fields
}

TemplateVersionsPager can be used to simplify the use of the "ListTemplateVersions" method.

func (*TemplateVersionsPager) GetAll added in v0.44.0 

func (pager *TemplateVersionsPager) GetAll() (allItems []ListTemplateVersionResponse, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*TemplateVersionsPager) GetAllWithContext added in v0.44.0 

func (pager *TemplateVersionsPager) GetAllWithContext(ctx context.Context) (allItems []ListTemplateVersionResponse, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*TemplateVersionsPager) GetNext added in v0.44.0 

func (pager *TemplateVersionsPager) GetNext() (page []ListTemplateVersionResponse, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*TemplateVersionsPager) GetNextWithContext added in v0.44.0 

func (pager *TemplateVersionsPager) GetNextWithContext(ctx context.Context) (page []ListTemplateVersionResponse, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*TemplateVersionsPager) HasNext added in v0.44.0 

func (pager *TemplateVersionsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type TemplatesPager added in v0.44.0 

type TemplatesPager struct {
	// contains filtered or unexported fields
}

TemplatesPager can be used to simplify the use of the "ListTemplates" method.

func (*TemplatesPager) GetAll added in v0.44.0 

func (pager *TemplatesPager) GetAll() (allItems []GroupTemplate, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*TemplatesPager) GetAllWithContext added in v0.44.0 

func (pager *TemplatesPager) GetAllWithContext(ctx context.Context) (allItems []GroupTemplate, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*TemplatesPager) GetNext added in v0.44.0 

func (pager *TemplatesPager) GetNext() (page []GroupTemplate, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*TemplatesPager) GetNextWithContext added in v0.44.0 

func (pager *TemplatesPager) GetNextWithContext(ctx context.Context) (page []GroupTemplate, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*TemplatesPager) HasNext added in v0.44.0 

func (pager *TemplatesPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type UpdateAccessGroupOptions 

type UpdateAccessGroupOptions struct {
	// The access group identifier.
	AccessGroupID *string `json:"access_group_id" validate:"required,ne="`

	// The current revision number of the group being updated. This can be found in the Create/Get access group response
	// ETag header.
	IfMatch *string `json:"If-Match" validate:"required"`

	// 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.
	Name *string `json:"name,omitempty"`

	// Assign an optional description for the access group. This field has a limit of 250 characters.
	Description *string `json:"description,omitempty"`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateAccessGroupOptions : The UpdateAccessGroup options.

func (*UpdateAccessGroupOptions) SetAccessGroupID 

func (_options *UpdateAccessGroupOptions) SetAccessGroupID(accessGroupID string) *UpdateAccessGroupOptions

SetAccessGroupID : Allow user to set AccessGroupID

func (*UpdateAccessGroupOptions) SetDescription 

func (_options *UpdateAccessGroupOptions) SetDescription(description string) *UpdateAccessGroupOptions

SetDescription : Allow user to set Description

func (*UpdateAccessGroupOptions) SetHeaders 

func (options *UpdateAccessGroupOptions) SetHeaders(param map[string]string) *UpdateAccessGroupOptions

SetHeaders : Allow user to set Headers

func (*UpdateAccessGroupOptions) SetIfMatch 

func (_options *UpdateAccessGroupOptions) SetIfMatch(ifMatch string) *UpdateAccessGroupOptions

SetIfMatch : Allow user to set IfMatch

func (*UpdateAccessGroupOptions) SetName 

func (_options *UpdateAccessGroupOptions) SetName(name string) *UpdateAccessGroupOptions

SetName : Allow user to set Name

func (*UpdateAccessGroupOptions) SetTransactionID 

func (_options *UpdateAccessGroupOptions) SetTransactionID(transactionID string) *UpdateAccessGroupOptions

SetTransactionID : Allow user to set TransactionID

type UpdateAccountSettingsOptions 

type UpdateAccountSettingsOptions struct {
	// 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.
	AccountID *string `json:"account_id" validate:"required"`

	// 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.
	PublicAccessEnabled *bool `json:"public_access_enabled,omitempty"`

	// An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple
	// services by using one identifier. The header key must be set to Transaction-Id and the value is anything that you
	// choose. If no transaction ID is passed in, then a random ID is generated.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateAccountSettingsOptions : The UpdateAccountSettings options.

func (*UpdateAccountSettingsOptions) SetAccountID 

func (_options *UpdateAccountSettingsOptions) SetAccountID(accountID string) *UpdateAccountSettingsOptions

SetAccountID : Allow user to set AccountID

func (*UpdateAccountSettingsOptions) SetHeaders 

func (options *UpdateAccountSettingsOptions) SetHeaders(param map[string]string) *UpdateAccountSettingsOptions

SetHeaders : Allow user to set Headers

func (*UpdateAccountSettingsOptions) SetPublicAccessEnabled 

func (_options *UpdateAccountSettingsOptions) SetPublicAccessEnabled(publicAccessEnabled bool) *UpdateAccountSettingsOptions

SetPublicAccessEnabled : Allow user to set PublicAccessEnabled

func (*UpdateAccountSettingsOptions) SetTransactionID 

func (_options *UpdateAccountSettingsOptions) SetTransactionID(transactionID string) *UpdateAccountSettingsOptions

SetTransactionID : Allow user to set TransactionID

type UpdateAssignmentOptions added in v0.44.0 

type UpdateAssignmentOptions struct {
	// ID of the Assignment Record.
	AssignmentID *string `json:"assignment_id" validate:"required,ne="`

	// Version of the Assignment to be updated. Specify the version that you retrieved when reading the Assignment. This
	// value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might
	// result in stale updates.
	IfMatch *string `json:"If-Match" validate:"required"`

	// Template version which shall be applied to the assignment.
	TemplateVersion *string `json:"template_version" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateAssignmentOptions : The UpdateAssignment options.

func (*UpdateAssignmentOptions) SetAssignmentID added in v0.44.0 

func (_options *UpdateAssignmentOptions) SetAssignmentID(assignmentID string) *UpdateAssignmentOptions

SetAssignmentID : Allow user to set AssignmentID

func (*UpdateAssignmentOptions) SetHeaders added in v0.44.0 

func (options *UpdateAssignmentOptions) SetHeaders(param map[string]string) *UpdateAssignmentOptions

SetHeaders : Allow user to set Headers

func (*UpdateAssignmentOptions) SetIfMatch added in v0.44.0 

func (_options *UpdateAssignmentOptions) SetIfMatch(ifMatch string) *UpdateAssignmentOptions

SetIfMatch : Allow user to set IfMatch

func (*UpdateAssignmentOptions) SetTemplateVersion added in v0.44.0 

func (_options *UpdateAssignmentOptions) SetTemplateVersion(templateVersion string) *UpdateAssignmentOptions

SetTemplateVersion : Allow user to set TemplateVersion

type UpdateTemplateVersionOptions added in v0.44.0 

type UpdateTemplateVersionOptions struct {
	// ID of the template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// Version number of the template.
	VersionNum *string `json:"version_num" validate:"required,ne="`

	// ETag value of the template version document.
	IfMatch *string `json:"If-Match" validate:"required"`

	// This is an optional field. If the field is included it will change the name value for all existing versions of the
	// template..
	Name *string `json:"name,omitempty"`

	// Assign an optional description for the access group template version.
	Description *string `json:"description,omitempty"`

	// Access Group Component.
	Group *AccessGroupRequest `json:"group,omitempty"`

	// The policy templates associated with the template version.
	PolicyTemplateReferences []PolicyTemplates `json:"policy_template_references,omitempty"`

	// transaction id in header.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateTemplateVersionOptions : The UpdateTemplateVersion options.

func (*UpdateTemplateVersionOptions) SetDescription added in v0.44.0 

func (_options *UpdateTemplateVersionOptions) SetDescription(description string) *UpdateTemplateVersionOptions

SetDescription : Allow user to set Description

func (*UpdateTemplateVersionOptions) SetGroup added in v0.44.0 

func (_options *UpdateTemplateVersionOptions) SetGroup(group *AccessGroupRequest) *UpdateTemplateVersionOptions

SetGroup : Allow user to set Group

func (*UpdateTemplateVersionOptions) SetHeaders added in v0.44.0 

func (options *UpdateTemplateVersionOptions) SetHeaders(param map[string]string) *UpdateTemplateVersionOptions

SetHeaders : Allow user to set Headers

func (*UpdateTemplateVersionOptions) SetIfMatch added in v0.44.0 

func (_options *UpdateTemplateVersionOptions) SetIfMatch(ifMatch string) *UpdateTemplateVersionOptions

SetIfMatch : Allow user to set IfMatch

func (*UpdateTemplateVersionOptions) SetName added in v0.44.0 

func (_options *UpdateTemplateVersionOptions) SetName(name string) *UpdateTemplateVersionOptions

SetName : Allow user to set Name

func (*UpdateTemplateVersionOptions) SetPolicyTemplateReferences added in v0.44.0 

func (_options *UpdateTemplateVersionOptions) SetPolicyTemplateReferences(policyTemplateReferences []PolicyTemplates) *UpdateTemplateVersionOptions

SetPolicyTemplateReferences : Allow user to set PolicyTemplateReferences

func (*UpdateTemplateVersionOptions) SetTemplateID added in v0.44.0 

func (_options *UpdateTemplateVersionOptions) SetTemplateID(templateID string) *UpdateTemplateVersionOptions

SetTemplateID : Allow user to set TemplateID

func (*UpdateTemplateVersionOptions) SetTransactionID added in v0.44.0 

func (_options *UpdateTemplateVersionOptions) SetTransactionID(transactionID string) *UpdateTemplateVersionOptions

SetTransactionID : Allow user to set TransactionID

func (*UpdateTemplateVersionOptions) SetVersionNum added in v0.44.0 

func (_options *UpdateTemplateVersionOptions) SetVersionNum(versionNum string) *UpdateTemplateVersionOptions

SetVersionNum : Allow user to set VersionNum

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.