iamaccessgroupsv2

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Apr 6, 2022 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 (
	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 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 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 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 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 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 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 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.

Types

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="`

	// The number of hours that the rule lives for.
	Expiration *int64 `json:"expiration" validate:"required"`

	// The url of the identity provider.
	RealmName *string `json:"realm_name" validate:"required"`

	// A list of conditions the rule must satisfy.
	Conditions []RuleConditions `json:"conditions" validate:"required"`

	// The name of the 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 "trusted 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` or `service`.
	Type *string `json:"type,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"`

	// 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 "trusted 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 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"`

	// Assign the specified name to the access group. This field is case-insensitive and has a limit of 100 characters. The
	// group name has to be unique within an account.
	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 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 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 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 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 the group was created at.
	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 the group was last edited at.
	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"`

	// Type of the membership. `static` or `dynamic`.
	MembershipType *string `json:"membership_type,omitempty"`
}

Group : An IAM access group.

type GroupMembersList 

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

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

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

	// 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 GroupsList 

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

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

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

	// 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/iam/accessgroup_rules.html#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) 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) 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) 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) GetEnableGzipCompression added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*IamAccessGroupsV2) GetServiceURL added in v0.12.2 

func (iamAccessGroups *IamAccessGroupsV2) GetServiceURL() string

GetServiceURL returns the service URL

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) 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) NewCreateAccessGroupOptions 

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

NewCreateAccessGroupOptions : Instantiate CreateAccessGroupOptions

func (*IamAccessGroupsV2) NewDeleteAccessGroupOptions 

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

NewDeleteAccessGroupOptions : Instantiate DeleteAccessGroupOptions

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) 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) 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) 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) 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

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. Membership type can be either `static`, `dynamic` or `all`. `static` lists those
	// members explicitly added to the access group, `dynamic` lists those members part of access group via dynamic rules
	// at the moment. `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"`

	// 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) 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 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 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"`

	// The number of hours that the rule lives for.
	Expiration *int64 `json:"expiration" validate:"required"`

	// The url of the identity provider.
	RealmName *string `json:"realm_name" validate:"required"`

	// A list of conditions the rule must satisfy.
	Conditions []RuleConditions `json:"conditions" validate:"required"`

	// The name of the 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 Rule 

type Rule struct {
	// The rule id.
	ID *string `json:"id,omitempty"`

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

	// The number of hours that the rule lives for (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 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 the rule must satisfy.
	Conditions []RuleConditions `json:"conditions,omitempty"`

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

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

	// The timestamp the rule was last edited at.
	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 rule of an access group.

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 rule.

type RulesList 

type RulesList struct {
	// A list of rules.
	Rules []Rule `json:"rules,omitempty"`
}

RulesList : A list of rules attached to the access group.

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"`

	// Assign the specified name to the access group. This field is case-insensitive and has a limit of 100 characters. The
	// group name has to be unique within an account.
	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

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.