iamidentityv1

package
v0.62.1 Latest Latest
Warning

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

 Go to latest Published: Apr 2, 2024 License: Apache-2.0 Imports: 9 Imported by: 32

Documentation

Overview

Package iamidentityv1 : Operations and models for the IamIdentityV1 service

Index

Constants

View Source 
const (
	AccountSettingsComponentRestrictCreateServiceIDNotRestrictedConst = "NOT_RESTRICTED"
	AccountSettingsComponentRestrictCreateServiceIDNotSetConst        = "NOT_SET"
	AccountSettingsComponentRestrictCreateServiceIDRestrictedConst    = "RESTRICTED"
)

Constants associated with the AccountSettingsComponent.RestrictCreateServiceID property. Defines whether or not creating a service ID is access controlled. Valid values:

  • RESTRICTED - only users assigned the 'Service ID creator' role on the IAM Identity Service can create service

IDs, including the account owner

  • NOT_RESTRICTED - all members of an account can create service IDs
  • NOT_SET - to 'unset' a previous set value.
View Source 
const (
	AccountSettingsComponentRestrictCreatePlatformApikeyNotRestrictedConst = "NOT_RESTRICTED"
	AccountSettingsComponentRestrictCreatePlatformApikeyNotSetConst        = "NOT_SET"
	AccountSettingsComponentRestrictCreatePlatformApikeyRestrictedConst    = "RESTRICTED"
)

Constants associated with the AccountSettingsComponent.RestrictCreatePlatformApikey property. Defines whether or not creating platform API keys is access controlled. Valid values:

  • RESTRICTED - to apply access control
  • NOT_RESTRICTED - to remove access control
  • NOT_SET - to 'unset' a previous set value.
View Source 
const (
	AccountSettingsComponentMfaLevel1Const     = "LEVEL1"
	AccountSettingsComponentMfaLevel2Const     = "LEVEL2"
	AccountSettingsComponentMfaLevel3Const     = "LEVEL3"
	AccountSettingsComponentMfaNoneConst       = "NONE"
	AccountSettingsComponentMfaNoneNoRopcConst = "NONE_NO_ROPC"
	AccountSettingsComponentMfaTotpConst       = "TOTP"
	AccountSettingsComponentMfaTotp4allConst   = "TOTP4ALL"
)

Constants associated with the AccountSettingsComponent.Mfa property. Defines the MFA trait for the account. Valid values:

  • NONE - No MFA trait set
  • NONE_NO_ROPC- No MFA, disable CLI logins with only a password
  • TOTP - For all non-federated IBMId users
  • TOTP4ALL - For all users
  • LEVEL1 - Email-based MFA for all users
  • LEVEL2 - TOTP-based MFA for all users
  • LEVEL3 - U2F MFA for all users.
View Source 
const (
	AccountSettingsResponseRestrictCreateServiceIDNotRestrictedConst = "NOT_RESTRICTED"
	AccountSettingsResponseRestrictCreateServiceIDNotSetConst        = "NOT_SET"
	AccountSettingsResponseRestrictCreateServiceIDRestrictedConst    = "RESTRICTED"
)

Constants associated with the AccountSettingsResponse.RestrictCreateServiceID property. Defines whether or not creating a service ID is access controlled. Valid values:

  • RESTRICTED - only users assigned the 'Service ID creator' role on the IAM Identity Service can create service

IDs, including the account owner

  • NOT_RESTRICTED - all members of an account can create service IDs
  • NOT_SET - to 'unset' a previous set value.
View Source 
const (
	AccountSettingsResponseRestrictCreatePlatformApikeyNotRestrictedConst = "NOT_RESTRICTED"
	AccountSettingsResponseRestrictCreatePlatformApikeyNotSetConst        = "NOT_SET"
	AccountSettingsResponseRestrictCreatePlatformApikeyRestrictedConst    = "RESTRICTED"
)

Constants associated with the AccountSettingsResponse.RestrictCreatePlatformApikey property. Defines whether or not creating platform API keys is access controlled. Valid values:

  • RESTRICTED - to apply access control
  • NOT_RESTRICTED - to remove access control
  • NOT_SET - to 'unset' a previous set value.
View Source 
const (
	AccountSettingsResponseMfaLevel1Const     = "LEVEL1"
	AccountSettingsResponseMfaLevel2Const     = "LEVEL2"
	AccountSettingsResponseMfaLevel3Const     = "LEVEL3"
	AccountSettingsResponseMfaNoneConst       = "NONE"
	AccountSettingsResponseMfaNoneNoRopcConst = "NONE_NO_ROPC"
	AccountSettingsResponseMfaTotpConst       = "TOTP"
	AccountSettingsResponseMfaTotp4allConst   = "TOTP4ALL"
)

Constants associated with the AccountSettingsResponse.Mfa property. Defines the MFA trait for the account. Valid values:

  • NONE - No MFA trait set
  • NONE_NO_ROPC- No MFA, disable CLI logins with only a password
  • TOTP - For all non-federated IBMId users
  • TOTP4ALL - For all users
  • LEVEL1 - Email-based MFA for all users
  • LEVEL2 - TOTP-based MFA for all users
  • LEVEL3 - U2F MFA for all users.
View Source 
const (
	AccountSettingsUserMfaMfaLevel1Const     = "LEVEL1"
	AccountSettingsUserMfaMfaLevel2Const     = "LEVEL2"
	AccountSettingsUserMfaMfaLevel3Const     = "LEVEL3"
	AccountSettingsUserMfaMfaNoneConst       = "NONE"
	AccountSettingsUserMfaMfaNoneNoRopcConst = "NONE_NO_ROPC"
	AccountSettingsUserMfaMfaTotpConst       = "TOTP"
	AccountSettingsUserMfaMfaTotp4allConst   = "TOTP4ALL"
)

Constants associated with the AccountSettingsUserMfa.Mfa property. Defines the MFA requirement for the user. Valid values:

  • NONE - No MFA trait set
  • NONE_NO_ROPC- No MFA, disable CLI logins with only a password
  • TOTP - For all non-federated IBMId users
  • TOTP4ALL - For all users
  • LEVEL1 - Email-based MFA for all users
  • LEVEL2 - TOTP-based MFA for all users
  • LEVEL3 - U2F MFA for all users.
View Source 
const (
	CreateAccountSettingsAssignmentOptionsTargetTypeAccountConst      = "Account"
	CreateAccountSettingsAssignmentOptionsTargetTypeAccountgroupConst = "AccountGroup"
)

Constants associated with the CreateAccountSettingsAssignmentOptions.TargetType property. Type of target to deploy to.

View Source 
const (
	CreateTrustedProfileAssignmentOptionsTargetTypeAccountConst      = "Account"
	CreateTrustedProfileAssignmentOptionsTargetTypeAccountgroupConst = "AccountGroup"
)

Constants associated with the CreateTrustedProfileAssignmentOptions.TargetType property. Type of target to deploy to.

View Source 
const (
	DeleteProfileIdentityOptionsIdentityTypeCRNConst       = "crn"
	DeleteProfileIdentityOptionsIdentityTypeServiceidConst = "serviceid"
	DeleteProfileIdentityOptionsIdentityTypeUserConst      = "user"
)

Constants associated with the DeleteProfileIdentityOptions.IdentityType property. Type of the identity.

View Source 
const (
	GetProfileIdentityOptionsIdentityTypeCRNConst       = "crn"
	GetProfileIdentityOptionsIdentityTypeServiceidConst = "serviceid"
	GetProfileIdentityOptionsIdentityTypeUserConst      = "user"
)

Constants associated with the GetProfileIdentityOptions.IdentityType property. Type of the identity.

View Source 
const (
	IDBasedMfaEnrollmentTraitAccountDefaultLevel1Const     = "LEVEL1"
	IDBasedMfaEnrollmentTraitAccountDefaultLevel2Const     = "LEVEL2"
	IDBasedMfaEnrollmentTraitAccountDefaultLevel3Const     = "LEVEL3"
	IDBasedMfaEnrollmentTraitAccountDefaultNoneConst       = "NONE"
	IDBasedMfaEnrollmentTraitAccountDefaultNoneNoRopcConst = "NONE_NO_ROPC"
	IDBasedMfaEnrollmentTraitAccountDefaultTotpConst       = "TOTP"
	IDBasedMfaEnrollmentTraitAccountDefaultTotp4allConst   = "TOTP4ALL"
)

Constants associated with the IDBasedMfaEnrollment.TraitAccountDefault property. Defines the MFA trait for the account. Valid values:

  • NONE - No MFA trait set
  • NONE_NO_ROPC- No MFA, disable CLI logins with only a password
  • TOTP - For all non-federated IBMId users
  • TOTP4ALL - For all users
  • LEVEL1 - Email-based MFA for all users
  • LEVEL2 - TOTP-based MFA for all users
  • LEVEL3 - U2F MFA for all users.
View Source 
const (
	IDBasedMfaEnrollmentTraitUserSpecificLevel1Const     = "LEVEL1"
	IDBasedMfaEnrollmentTraitUserSpecificLevel2Const     = "LEVEL2"
	IDBasedMfaEnrollmentTraitUserSpecificLevel3Const     = "LEVEL3"
	IDBasedMfaEnrollmentTraitUserSpecificNoneConst       = "NONE"
	IDBasedMfaEnrollmentTraitUserSpecificNoneNoRopcConst = "NONE_NO_ROPC"
	IDBasedMfaEnrollmentTraitUserSpecificTotpConst       = "TOTP"
	IDBasedMfaEnrollmentTraitUserSpecificTotp4allConst   = "TOTP4ALL"
)

Constants associated with the IDBasedMfaEnrollment.TraitUserSpecific property. Defines the MFA trait for the account. Valid values:

  • NONE - No MFA trait set
  • NONE_NO_ROPC- No MFA, disable CLI logins with only a password
  • TOTP - For all non-federated IBMId users
  • TOTP4ALL - For all users
  • LEVEL1 - Email-based MFA for all users
  • LEVEL2 - TOTP-based MFA for all users
  • LEVEL3 - U2F MFA for all users.
View Source 
const (
	IDBasedMfaEnrollmentTraitEffectiveLevel1Const     = "LEVEL1"
	IDBasedMfaEnrollmentTraitEffectiveLevel2Const     = "LEVEL2"
	IDBasedMfaEnrollmentTraitEffectiveLevel3Const     = "LEVEL3"
	IDBasedMfaEnrollmentTraitEffectiveNoneConst       = "NONE"
	IDBasedMfaEnrollmentTraitEffectiveNoneNoRopcConst = "NONE_NO_ROPC"
	IDBasedMfaEnrollmentTraitEffectiveTotpConst       = "TOTP"
	IDBasedMfaEnrollmentTraitEffectiveTotp4allConst   = "TOTP4ALL"
)

Constants associated with the IDBasedMfaEnrollment.TraitEffective property. Defines the MFA trait for the account. Valid values:

  • NONE - No MFA trait set
  • NONE_NO_ROPC- No MFA, disable CLI logins with only a password
  • TOTP - For all non-federated IBMId users
  • TOTP4ALL - For all users
  • LEVEL1 - Email-based MFA for all users
  • LEVEL2 - TOTP-based MFA for all users
  • LEVEL3 - U2F MFA for all users.
View Source 
const (
	IDBasedMfaEnrollmentComplyStateAccountConst      = "ACCOUNT"
	IDBasedMfaEnrollmentComplyStateCrossAccountConst = "CROSS_ACCOUNT"
	IDBasedMfaEnrollmentComplyStateNoConst           = "NO"
)

Constants associated with the IDBasedMfaEnrollment.ComplyState property. Defines comply state for the account. Valid values:

  • NO - User does not comply in the given account.
  • ACCOUNT- User complies in the given account, but does not comply in at least one of the other account

memberships.

  • CROSS_ACCOUNT - User complies in the given account and across all other account memberships.
View Source 
const (
	ListAccountSettingsAssignmentsOptionsTargetTypeAccountConst      = "Account"
	ListAccountSettingsAssignmentsOptionsTargetTypeAccountgroupConst = "AccountGroup"
)

Constants associated with the ListAccountSettingsAssignmentsOptions.TargetType property. Filter results by the assignment's target type.

View Source 
const (
	ListAccountSettingsAssignmentsOptionsSortCreatedAtConst      = "created_at"
	ListAccountSettingsAssignmentsOptionsSortLastModifiedAtConst = "last_modified_at"
	ListAccountSettingsAssignmentsOptionsSortTemplateIDConst     = "template_id"
)

Constants associated with the ListAccountSettingsAssignmentsOptions.Sort property. If specified, the items are sorted by the value of this property.

View Source 
const (
	ListAccountSettingsAssignmentsOptionsOrderAscConst  = "asc"
	ListAccountSettingsAssignmentsOptionsOrderDescConst = "desc"
)

Constants associated with the ListAccountSettingsAssignmentsOptions.Order property. Sort order.

View Source 
const (
	ListAccountSettingsTemplatesOptionsSortCreatedAtConst      = "created_at"
	ListAccountSettingsTemplatesOptionsSortLastModifiedAtConst = "last_modified_at"
	ListAccountSettingsTemplatesOptionsSortNameConst           = "name"
)

Constants associated with the ListAccountSettingsTemplatesOptions.Sort property. Optional sort property. If specified, the returned templated are sorted according to this property.

View Source 
const (
	ListAccountSettingsTemplatesOptionsOrderAscConst  = "asc"
	ListAccountSettingsTemplatesOptionsOrderDescConst = "desc"
)

Constants associated with the ListAccountSettingsTemplatesOptions.Order property. Optional sort order.

View Source 
const (
	ListAPIKeysOptionsScopeAccountConst = "account"
	ListAPIKeysOptionsScopeEntityConst  = "entity"
)

Constants associated with the ListAPIKeysOptions.Scope property. Optional parameter to define the scope of the queried API keys. Can be 'entity' (default) or 'account'.

View Source 
const (
	ListAPIKeysOptionsTypeServiceidConst = "serviceid"
	ListAPIKeysOptionsTypeUserConst      = "user"
)

Constants associated with the ListAPIKeysOptions.Type property. Optional parameter to filter the type of the queried API keys. Can be 'user' or 'serviceid'.

View Source 
const (
	ListAPIKeysOptionsOrderAscConst  = "asc"
	ListAPIKeysOptionsOrderDescConst = "desc"
)

Constants associated with the ListAPIKeysOptions.Order property. Optional sort order, valid values are asc and desc. Default: asc.

View Source 
const (
	ListProfileTemplatesOptionsSortCreatedAtConst      = "created_at"
	ListProfileTemplatesOptionsSortLastModifiedAtConst = "last_modified_at"
	ListProfileTemplatesOptionsSortNameConst           = "name"
)

Constants associated with the ListProfileTemplatesOptions.Sort property. Optional sort property. If specified, the returned templates are sorted according to this property.

View Source 
const (
	ListProfileTemplatesOptionsOrderAscConst  = "asc"
	ListProfileTemplatesOptionsOrderDescConst = "desc"
)

Constants associated with the ListProfileTemplatesOptions.Order property. Optional sort order.

View Source 
const (
	ListProfilesOptionsOrderAscConst  = "asc"
	ListProfilesOptionsOrderDescConst = "desc"
)

Constants associated with the ListProfilesOptions.Order property. Optional sort order, valid values are asc and desc. Default: asc.

View Source 
const (
	ListServiceIdsOptionsOrderAscConst  = "asc"
	ListServiceIdsOptionsOrderDescConst = "desc"
)

Constants associated with the ListServiceIdsOptions.Order property. Optional sort order, valid values are asc and desc. Default: asc.

View Source 
const (
	ListTrustedProfileAssignmentsOptionsTargetTypeAccountConst      = "Account"
	ListTrustedProfileAssignmentsOptionsTargetTypeAccountgroupConst = "AccountGroup"
)

Constants associated with the ListTrustedProfileAssignmentsOptions.TargetType property. Filter results by the assignment's target type.

View Source 
const (
	ListTrustedProfileAssignmentsOptionsSortCreatedAtConst      = "created_at"
	ListTrustedProfileAssignmentsOptionsSortLastModifiedAtConst = "last_modified_at"
	ListTrustedProfileAssignmentsOptionsSortTemplateIDConst     = "template_id"
)

Constants associated with the ListTrustedProfileAssignmentsOptions.Sort property. If specified, the items are sorted by the value of this property.

View Source 
const (
	ListTrustedProfileAssignmentsOptionsOrderAscConst  = "asc"
	ListTrustedProfileAssignmentsOptionsOrderDescConst = "desc"
)

Constants associated with the ListTrustedProfileAssignmentsOptions.Order property. Sort order.

View Source 
const (
	ListVersionsOfAccountSettingsTemplateOptionsSortCreatedAtConst      = "created_at"
	ListVersionsOfAccountSettingsTemplateOptionsSortLastModifiedAtConst = "last_modified_at"
	ListVersionsOfAccountSettingsTemplateOptionsSortNameConst           = "name"
)

Constants associated with the ListVersionsOfAccountSettingsTemplateOptions.Sort property. Optional sort property. If specified, the returned templated are sorted according to this property.

View Source 
const (
	ListVersionsOfAccountSettingsTemplateOptionsOrderAscConst  = "asc"
	ListVersionsOfAccountSettingsTemplateOptionsOrderDescConst = "desc"
)

Constants associated with the ListVersionsOfAccountSettingsTemplateOptions.Order property. Optional sort order.

View Source 
const (
	ListVersionsOfProfileTemplateOptionsSortCreatedAtConst      = "created_at"
	ListVersionsOfProfileTemplateOptionsSortLastModifiedAtConst = "last_modified_at"
	ListVersionsOfProfileTemplateOptionsSortNameConst           = "name"
)

Constants associated with the ListVersionsOfProfileTemplateOptions.Sort property. Optional sort property. If specified, the returned templated are sorted according to this property.

View Source 
const (
	ListVersionsOfProfileTemplateOptionsOrderAscConst  = "asc"
	ListVersionsOfProfileTemplateOptionsOrderDescConst = "desc"
)

Constants associated with the ListVersionsOfProfileTemplateOptions.Order property. Optional sort order.

View Source 
const (
	ProfileIdentityRequestTypeCRNConst       = "crn"
	ProfileIdentityRequestTypeServiceidConst = "serviceid"
	ProfileIdentityRequestTypeUserConst      = "user"
)

Constants associated with the ProfileIdentityRequest.Type property. Type of the identity.

View Source 
const (
	ProfileIdentityResponseTypeCRNConst       = "crn"
	ProfileIdentityResponseTypeServiceidConst = "serviceid"
	ProfileIdentityResponseTypeUserConst      = "user"
)

Constants associated with the ProfileIdentityResponse.Type property. Type of the identity.

View Source 
const (
	SetProfileIdentityOptionsIdentityTypeCRNConst       = "crn"
	SetProfileIdentityOptionsIdentityTypeServiceidConst = "serviceid"
	SetProfileIdentityOptionsIdentityTypeUserConst      = "user"
)

Constants associated with the SetProfileIdentityOptions.IdentityType property. Type of the identity.

View Source 
const (
	SetProfileIdentityOptionsTypeCRNConst       = "crn"
	SetProfileIdentityOptionsTypeServiceidConst = "serviceid"
	SetProfileIdentityOptionsTypeUserConst      = "user"
)

Constants associated with the SetProfileIdentityOptions.Type property. Type of the identity.

View Source 
const (
	UpdateAccountSettingsOptionsRestrictCreateServiceIDNotRestrictedConst = "NOT_RESTRICTED"
	UpdateAccountSettingsOptionsRestrictCreateServiceIDNotSetConst        = "NOT_SET"
	UpdateAccountSettingsOptionsRestrictCreateServiceIDRestrictedConst    = "RESTRICTED"
)

Constants associated with the UpdateAccountSettingsOptions.RestrictCreateServiceID property. Defines whether or not creating a service ID is access controlled. Valid values:

  • RESTRICTED - only users assigned the 'Service ID creator' role on the IAM Identity Service can create service

IDs, including the account owner

  • NOT_RESTRICTED - all members of an account can create service IDs
  • NOT_SET - to 'unset' a previous set value.
View Source 
const (
	UpdateAccountSettingsOptionsRestrictCreatePlatformApikeyNotRestrictedConst = "NOT_RESTRICTED"
	UpdateAccountSettingsOptionsRestrictCreatePlatformApikeyNotSetConst        = "NOT_SET"
	UpdateAccountSettingsOptionsRestrictCreatePlatformApikeyRestrictedConst    = "RESTRICTED"
)

Constants associated with the UpdateAccountSettingsOptions.RestrictCreatePlatformApikey property. Defines whether or not creating platform API keys is access controlled. Valid values:

  • RESTRICTED - only users assigned the 'User API key creator' role on the IAM Identity Service can create API keys,

including the account owner

  • NOT_RESTRICTED - all members of an account can create platform API keys
  • NOT_SET - to 'unset' a previous set value.
View Source 
const (
	UpdateAccountSettingsOptionsMfaLevel1Const     = "LEVEL1"
	UpdateAccountSettingsOptionsMfaLevel2Const     = "LEVEL2"
	UpdateAccountSettingsOptionsMfaLevel3Const     = "LEVEL3"
	UpdateAccountSettingsOptionsMfaNoneConst       = "NONE"
	UpdateAccountSettingsOptionsMfaNoneNoRopcConst = "NONE_NO_ROPC"
	UpdateAccountSettingsOptionsMfaTotpConst       = "TOTP"
	UpdateAccountSettingsOptionsMfaTotp4allConst   = "TOTP4ALL"
)

Constants associated with the UpdateAccountSettingsOptions.Mfa property. Defines the MFA trait for the account. Valid values:

  • NONE - No MFA trait set
  • NONE_NO_ROPC- No MFA, disable CLI logins with only a password
  • TOTP - For all non-federated IBMId users
  • TOTP4ALL - For all users
  • LEVEL1 - Email-based MFA for all users
  • LEVEL2 - TOTP-based MFA for all users
  • LEVEL3 - U2F MFA for all users.
View Source 
const DefaultServiceName = "iam_identity"

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.

View Source 
const (
	TrustedProfileTemplateClaimRuleTypeProfileSamlConst = "Profile-SAML"
)

Constants associated with the TrustedProfileTemplateClaimRule.Type property. Type of the claim rule.

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 UnmarshalAPIKey added in v0.17.2 

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

UnmarshalAPIKey unmarshals an instance of APIKey from the specified map of raw messages.

func UnmarshalAPIKeyInsideCreateServiceIDRequest added in v0.17.2 

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

UnmarshalAPIKeyInsideCreateServiceIDRequest unmarshals an instance of APIKeyInsideCreateServiceIDRequest from the specified map of raw messages.

func UnmarshalAPIKeyList added in v0.17.2 

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

UnmarshalAPIKeyList unmarshals an instance of APIKeyList from the specified map of raw messages.

func UnmarshalAccountBasedMfaEnrollment added in v0.31.6 

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

UnmarshalAccountBasedMfaEnrollment unmarshals an instance of AccountBasedMfaEnrollment from the specified map of raw messages.

func UnmarshalAccountSettingsComponent added in v0.42.0 

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

UnmarshalAccountSettingsComponent unmarshals an instance of AccountSettingsComponent from the specified map of raw messages.

func UnmarshalAccountSettingsResponse added in v0.17.17 

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

UnmarshalAccountSettingsResponse unmarshals an instance of AccountSettingsResponse from the specified map of raw messages.

func UnmarshalAccountSettingsTemplateList added in v0.42.0 

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

UnmarshalAccountSettingsTemplateList unmarshals an instance of AccountSettingsTemplateList from the specified map of raw messages.

func UnmarshalAccountSettingsTemplateResponse added in v0.42.0 

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

UnmarshalAccountSettingsTemplateResponse unmarshals an instance of AccountSettingsTemplateResponse from the specified map of raw messages.

func UnmarshalAccountSettingsUserMfa added in v0.31.0 

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

UnmarshalAccountSettingsUserMfa unmarshals an instance of AccountSettingsUserMfa from the specified map of raw messages.

func UnmarshalActivity added in v0.24.0 

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

UnmarshalActivity unmarshals an instance of Activity from the specified map of raw messages.

func UnmarshalApikeyActivity added in v0.24.1 

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

UnmarshalApikeyActivity unmarshals an instance of ApikeyActivity from the specified map of raw messages.

func UnmarshalApikeyActivityServiceid added in v0.24.1 

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

UnmarshalApikeyActivityServiceid unmarshals an instance of ApikeyActivityServiceid from the specified map of raw messages.

func UnmarshalApikeyActivityUser added in v0.24.1 

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

UnmarshalApikeyActivityUser unmarshals an instance of ApikeyActivityUser from the specified map of raw messages. 

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

UnmarshalCreateProfileLinkRequestLink unmarshals an instance of CreateProfileLinkRequestLink from the specified map of raw messages.

func UnmarshalEnityHistoryRecord 

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

UnmarshalEnityHistoryRecord unmarshals an instance of EnityHistoryRecord from the specified map of raw messages.

func UnmarshalEntityActivity added in v0.24.0 

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

UnmarshalEntityActivity unmarshals an instance of EntityActivity from the specified map of raw messages.

func UnmarshalError added in v0.42.0 

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 UnmarshalExceptionResponse added in v0.42.0 

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

UnmarshalExceptionResponse unmarshals an instance of ExceptionResponse from the specified map of raw messages.

func UnmarshalIDBasedMfaEnrollment added in v0.31.6 

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

UnmarshalIDBasedMfaEnrollment unmarshals an instance of IDBasedMfaEnrollment from the specified map of raw messages.

func UnmarshalMfaEnrollmentTypeStatus added in v0.31.6 

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

UnmarshalMfaEnrollmentTypeStatus unmarshals an instance of MfaEnrollmentTypeStatus from the specified map of raw messages.

func UnmarshalMfaEnrollments added in v0.31.6 

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

UnmarshalMfaEnrollments unmarshals an instance of MfaEnrollments from the specified map of raw messages.

func UnmarshalPolicyTemplateReference added in v0.42.0 

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

UnmarshalPolicyTemplateReference unmarshals an instance of PolicyTemplateReference from the specified map of raw messages.

func UnmarshalProfileClaimRule added in v0.20.0 

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

UnmarshalProfileClaimRule unmarshals an instance of ProfileClaimRule from the specified map of raw messages.

func UnmarshalProfileClaimRuleConditions added in v0.20.0 

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

UnmarshalProfileClaimRuleConditions unmarshals an instance of ProfileClaimRuleConditions from the specified map of raw messages.

func UnmarshalProfileClaimRuleList added in v0.20.0 

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

UnmarshalProfileClaimRuleList unmarshals an instance of ProfileClaimRuleList from the specified map of raw messages.

func UnmarshalProfileIdentitiesResponse added in v0.40.0 

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

UnmarshalProfileIdentitiesResponse unmarshals an instance of ProfileIdentitiesResponse from the specified map of raw messages.

func UnmarshalProfileIdentityRequest added in v0.42.0 

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

UnmarshalProfileIdentityRequest unmarshals an instance of ProfileIdentityRequest from the specified map of raw messages.

func UnmarshalProfileIdentityResponse added in v0.42.0 

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

UnmarshalProfileIdentityResponse unmarshals an instance of ProfileIdentityResponse from the specified map of raw messages. 

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

UnmarshalProfileLink unmarshals an instance of ProfileLink from the specified map of raw messages. 

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

UnmarshalProfileLinkLink unmarshals an instance of ProfileLinkLink from the specified map of raw messages. 

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

UnmarshalProfileLinkList unmarshals an instance of ProfileLinkList from the specified map of raw messages.

func UnmarshalReport added in v0.24.0 

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

UnmarshalReport unmarshals an instance of Report from the specified map of raw messages.

func UnmarshalReportMfaEnrollmentStatus added in v0.31.6 

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

UnmarshalReportMfaEnrollmentStatus unmarshals an instance of ReportMfaEnrollmentStatus from the specified map of raw messages.

func UnmarshalReportReference added in v0.24.0 

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

UnmarshalReportReference unmarshals an instance of ReportReference from the specified map of raw messages.

func UnmarshalResponseContext 

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

UnmarshalResponseContext unmarshals an instance of ResponseContext from the specified map of raw messages.

func UnmarshalServiceID 

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

UnmarshalServiceID unmarshals an instance of ServiceID from the specified map of raw messages.

func UnmarshalServiceIDList added in v0.17.2 

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

UnmarshalServiceIDList unmarshals an instance of ServiceIDList from the specified map of raw messages.

func UnmarshalTemplateAssignmentListResponse added in v0.42.0 

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

UnmarshalTemplateAssignmentListResponse unmarshals an instance of TemplateAssignmentListResponse from the specified map of raw messages.

func UnmarshalTemplateAssignmentResource added in v0.42.0 

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

UnmarshalTemplateAssignmentResource unmarshals an instance of TemplateAssignmentResource from the specified map of raw messages.

func UnmarshalTemplateAssignmentResourceError added in v0.42.0 

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

UnmarshalTemplateAssignmentResourceError unmarshals an instance of TemplateAssignmentResourceError from the specified map of raw messages.

func UnmarshalTemplateAssignmentResponse added in v0.42.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 UnmarshalTemplateAssignmentResponseResource added in v0.42.0 

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

UnmarshalTemplateAssignmentResponseResource unmarshals an instance of TemplateAssignmentResponseResource from the specified map of raw messages.

func UnmarshalTemplateAssignmentResponseResourceDetail added in v0.42.0 

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

UnmarshalTemplateAssignmentResponseResourceDetail unmarshals an instance of TemplateAssignmentResponseResourceDetail from the specified map of raw messages.

func UnmarshalTemplateProfileComponentRequest added in v0.42.0 

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

UnmarshalTemplateProfileComponentRequest unmarshals an instance of TemplateProfileComponentRequest from the specified map of raw messages.

func UnmarshalTemplateProfileComponentResponse added in v0.42.0 

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

UnmarshalTemplateProfileComponentResponse unmarshals an instance of TemplateProfileComponentResponse from the specified map of raw messages.

func UnmarshalTrustedProfile added in v0.20.0 

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

UnmarshalTrustedProfile unmarshals an instance of TrustedProfile from the specified map of raw messages.

func UnmarshalTrustedProfileTemplateClaimRule added in v0.42.0 

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

UnmarshalTrustedProfileTemplateClaimRule unmarshals an instance of TrustedProfileTemplateClaimRule from the specified map of raw messages.

func UnmarshalTrustedProfileTemplateList added in v0.42.0 

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

UnmarshalTrustedProfileTemplateList unmarshals an instance of TrustedProfileTemplateList from the specified map of raw messages.

func UnmarshalTrustedProfileTemplateResponse added in v0.42.0 

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

UnmarshalTrustedProfileTemplateResponse unmarshals an instance of TrustedProfileTemplateResponse from the specified map of raw messages.

func UnmarshalTrustedProfilesList added in v0.20.0 

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

UnmarshalTrustedProfilesList unmarshals an instance of TrustedProfilesList from the specified map of raw messages.

func UnmarshalUserActivity added in v0.24.0 

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

UnmarshalUserActivity unmarshals an instance of UserActivity from the specified map of raw messages.

func UnmarshalUserMfaEnrollments added in v0.31.6 

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

UnmarshalUserMfaEnrollments unmarshals an instance of UserMfaEnrollments from the specified map of raw messages.

func UnmarshalUserReportMfaEnrollmentStatus added in v0.31.6 

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

UnmarshalUserReportMfaEnrollmentStatus unmarshals an instance of UserReportMfaEnrollmentStatus from the specified map of raw messages.

Types

type APIKey added in v0.17.2 

type APIKey struct {
	// Context with key properties for problem determination.
	Context *ResponseContext `json:"context,omitempty"`

	// Unique identifier of this API Key.
	ID *string `json:"id" validate:"required"`

	// Version of the API Key details object. You need to specify this value when updating the API key to avoid stale
	// updates.
	EntityTag *string `json:"entity_tag,omitempty"`

	// Cloud Resource Name of the item. Example Cloud Resource Name:
	// 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
	CRN *string `json:"crn" validate:"required"`

	// The API key cannot be changed if set to true.
	Locked *bool `json:"locked" validate:"required"`

	// Defines if API key is disabled, API key cannot be used if 'disabled' is set to true.
	Disabled *bool `json:"disabled,omitempty"`

	// If set contains a date time string of the creation date in ISO format.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// IAM ID of the user or service which created the API key.
	CreatedBy *string `json:"created_by" validate:"required"`

	// If set contains a date time string of the last modification date in ISO format.
	ModifiedAt *strfmt.DateTime `json:"modified_at,omitempty"`

	// Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist.
	// Access is done via the UUID of the API key.
	Name *string `json:"name" validate:"required"`

	// Defines if the API key supports sessions. Sessions are only supported for user apikeys.
	SupportSessions *bool `json:"support_sessions,omitempty"`

	// Defines the action to take when API key is leaked, valid values are 'none', 'disable' and 'delete'.
	ActionWhenLeaked *string `json:"action_when_leaked,omitempty"`

	// The optional description of the API key. The 'description' property is only available if a description was provided
	// during a create of an API key.
	Description *string `json:"description,omitempty"`

	// The iam_id that this API key authenticates.
	IamID *string `json:"iam_id" validate:"required"`

	// ID of the account that this API key authenticates for.
	AccountID *string `json:"account_id" validate:"required"`

	// The API key value. This property only contains the API key value for the following cases: create an API key, update
	// a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API
	// key value as retrievable. All other operations don't return the API key value, for example all user API key related
	// operations, except for create, don't contain the API key value.
	Apikey *string `json:"apikey" validate:"required"`

	// History of the API key.
	History []EnityHistoryRecord `json:"history,omitempty"`

	Activity *Activity `json:"activity,omitempty"`
}

APIKey : Response body format for API key V1 REST requests.

type APIKeyInsideCreateServiceIDRequest added in v0.17.2 

type APIKeyInsideCreateServiceIDRequest struct {
	// Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist.
	// Access is done via the UUID of the API key.
	Name *string `json:"name" validate:"required"`

	// The optional description of the API key. The 'description' property is only available if a description was provided
	// during a create of an API key.
	Description *string `json:"description,omitempty"`

	// You can optionally passthrough the API key value for this API key. If passed, a minimum length validation of 32
	// characters for that apiKey value is done, i.e. the value can contain any characters and can even be non-URL safe,
	// but the minimum length requirement must be met. If omitted, the API key management will create an URL safe opaque
	// API key value. The value of the API key is checked for uniqueness. Ensure enough variations when passing in this
	// value.
	Apikey *string `json:"apikey,omitempty"`

	// Send true or false to set whether the API key value is retrievable in the future by using the Get details of an API
	// key request. If you create an API key for a user, you must specify `false` or omit the value. We don't allow storing
	// of API keys for users.
	StoreValue *bool `json:"store_value,omitempty"`
}

APIKeyInsideCreateServiceIDRequest : Parameters for the API key in the Create service Id V1 REST request.

type APIKeyList added in v0.17.2 

type APIKeyList struct {
	// Context with key properties for problem determination.
	Context *ResponseContext `json:"context,omitempty"`

	// The offset of the current page.
	Offset *int64 `json:"offset,omitempty"`

	// Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
	Limit *int64 `json:"limit,omitempty"`

	// Link to the first page.
	First *string `json:"first,omitempty"`

	// Link to the previous available page. If 'previous' property is not part of the response no previous page is
	// available.
	Previous *string `json:"previous,omitempty"`

	// Link to the next available page. If 'next' property is not part of the response no next page is available.
	Next *string `json:"next,omitempty"`

	// List of API keys based on the query paramters and the page size. The apikeys array is always part of the response
	// but might be empty depending on the query parameters values provided.
	Apikeys []APIKey `json:"apikeys" validate:"required"`
}

APIKeyList : Response body format for the List API keys V1 REST request.

type AccountBasedMfaEnrollment added in v0.31.6 

type AccountBasedMfaEnrollment struct {
	SecurityQuestions *MfaEnrollmentTypeStatus `json:"security_questions" validate:"required"`

	Totp *MfaEnrollmentTypeStatus `json:"totp" validate:"required"`

	Verisign *MfaEnrollmentTypeStatus `json:"verisign" validate:"required"`

	// The enrollment complies to the effective requirement.
	Complies *bool `json:"complies" validate:"required"`
}

AccountBasedMfaEnrollment : AccountBasedMfaEnrollment struct

type AccountSettingsComponent added in v0.42.0 

type AccountSettingsComponent struct {
	// Defines whether or not creating a service ID is access controlled. Valid values:
	//   * RESTRICTED - only users assigned the 'Service ID creator' role on the IAM Identity Service can create service
	// IDs, including the account owner
	//   * NOT_RESTRICTED - all members of an account can create service IDs
	//   * NOT_SET - to 'unset' a previous set value.
	RestrictCreateServiceID *string `json:"restrict_create_service_id,omitempty"`

	// Defines whether or not creating platform API keys is access controlled. Valid values:
	//   * RESTRICTED - to apply access control
	//   * NOT_RESTRICTED - to remove access control
	//   * NOT_SET - to 'unset' a previous set value.
	RestrictCreatePlatformApikey *string `json:"restrict_create_platform_apikey,omitempty"`

	// Defines the IP addresses and subnets from which IAM tokens can be created for the account.
	AllowedIPAddresses *string `json:"allowed_ip_addresses,omitempty"`

	// Defines the MFA trait for the account. Valid values:
	//   * NONE - No MFA trait set
	//   * NONE_NO_ROPC- No MFA, disable CLI logins with only a password
	//   * TOTP - For all non-federated IBMId users
	//   * TOTP4ALL - For all users
	//   * LEVEL1 - Email-based MFA for all users
	//   * LEVEL2 - TOTP-based MFA for all users
	//   * LEVEL3 - U2F MFA for all users.
	Mfa *string `json:"mfa,omitempty"`

	// List of users that are exempted from the MFA requirement of the account.
	UserMfa []AccountSettingsUserMfa `json:"user_mfa,omitempty"`

	// Defines the session expiration in seconds for the account. Valid values:
	//   * Any whole number between between '900' and '86400'
	//   * NOT_SET - To unset account setting and use service default.
	SessionExpirationInSeconds *string `json:"session_expiration_in_seconds,omitempty"`

	// Defines the period of time in seconds in which a session will be invalidated due to inactivity. Valid values:
	//   * Any whole number between '900' and '7200'
	//   * NOT_SET - To unset account setting and use service default.
	SessionInvalidationInSeconds *string `json:"session_invalidation_in_seconds,omitempty"`

	// Defines the max allowed sessions per identity required by the account. Valid values:
	//   * Any whole number greater than 0
	//   * NOT_SET - To unset account setting and use service default.
	MaxSessionsPerIdentity *string `json:"max_sessions_per_identity,omitempty"`

	// Defines the access token expiration in seconds. Valid values:
	//   * Any whole number between '900' and '3600'
	//   * NOT_SET - To unset account setting and use service default.
	SystemAccessTokenExpirationInSeconds *string `json:"system_access_token_expiration_in_seconds,omitempty"`

	// Defines the refresh token expiration in seconds. Valid values:
	//   * Any whole number between '900' and '259200'
	//   * NOT_SET - To unset account setting and use service default.
	SystemRefreshTokenExpirationInSeconds *string `json:"system_refresh_token_expiration_in_seconds,omitempty"`
}

AccountSettingsComponent : AccountSettingsComponent struct

type AccountSettingsResponse added in v0.17.17 

type AccountSettingsResponse struct {
	// Context with key properties for problem determination.
	Context *ResponseContext `json:"context,omitempty"`

	// Unique ID of the account.
	AccountID *string `json:"account_id" validate:"required"`

	// Defines whether or not creating a service ID is access controlled. Valid values:
	//   * RESTRICTED - only users assigned the 'Service ID creator' role on the IAM Identity Service can create service
	// IDs, including the account owner
	//   * NOT_RESTRICTED - all members of an account can create service IDs
	//   * NOT_SET - to 'unset' a previous set value.
	RestrictCreateServiceID *string `json:"restrict_create_service_id" validate:"required"`

	// Defines whether or not creating platform API keys is access controlled. Valid values:
	//   * RESTRICTED - to apply access control
	//   * NOT_RESTRICTED - to remove access control
	//   * NOT_SET - to 'unset' a previous set value.
	RestrictCreatePlatformApikey *string `json:"restrict_create_platform_apikey" validate:"required"`

	// Defines the IP addresses and subnets from which IAM tokens can be created for the account.
	AllowedIPAddresses *string `json:"allowed_ip_addresses" validate:"required"`

	// Version of the account settings.
	EntityTag *string `json:"entity_tag" validate:"required"`

	// Defines the MFA trait for the account. Valid values:
	//   * NONE - No MFA trait set
	//   * NONE_NO_ROPC- No MFA, disable CLI logins with only a password
	//   * TOTP - For all non-federated IBMId users
	//   * TOTP4ALL - For all users
	//   * LEVEL1 - Email-based MFA for all users
	//   * LEVEL2 - TOTP-based MFA for all users
	//   * LEVEL3 - U2F MFA for all users.
	Mfa *string `json:"mfa" validate:"required"`

	// List of users that are exempted from the MFA requirement of the account.
	UserMfa []AccountSettingsUserMfa `json:"user_mfa" validate:"required"`

	// History of the Account Settings.
	History []EnityHistoryRecord `json:"history,omitempty"`

	// Defines the session expiration in seconds for the account. Valid values:
	//   * Any whole number between between '900' and '86400'
	//   * NOT_SET - To unset account setting and use service default.
	SessionExpirationInSeconds *string `json:"session_expiration_in_seconds" validate:"required"`

	// Defines the period of time in seconds in which a session will be invalidated due to inactivity. Valid values:
	//   * Any whole number between '900' and '7200'
	//   * NOT_SET - To unset account setting and use service default.
	SessionInvalidationInSeconds *string `json:"session_invalidation_in_seconds" validate:"required"`

	// Defines the max allowed sessions per identity required by the account. Valid values:
	//   * Any whole number greater than 0
	//   * NOT_SET - To unset account setting and use service default.
	MaxSessionsPerIdentity *string `json:"max_sessions_per_identity" validate:"required"`

	// Defines the access token expiration in seconds. Valid values:
	//   * Any whole number between '900' and '3600'
	//   * NOT_SET - To unset account setting and use service default.
	SystemAccessTokenExpirationInSeconds *string `json:"system_access_token_expiration_in_seconds" validate:"required"`

	// Defines the refresh token expiration in seconds. Valid values:
	//   * Any whole number between '900' and '259200'
	//   * NOT_SET - To unset account setting and use service default.
	SystemRefreshTokenExpirationInSeconds *string `json:"system_refresh_token_expiration_in_seconds" validate:"required"`
}

AccountSettingsResponse : Response body format for Account Settings REST requests.

type AccountSettingsTemplateList added in v0.42.0 

type AccountSettingsTemplateList struct {
	// Context with key properties for problem determination.
	Context *ResponseContext `json:"context,omitempty"`

	// The offset of the current page.
	Offset *int64 `json:"offset,omitempty"`

	// Optional size of a single page.
	Limit *int64 `json:"limit,omitempty"`

	// Link to the first page.
	First *string `json:"first,omitempty"`

	// Link to the previous available page. If 'previous' property is not part of the response no previous page is
	// available.
	Previous *string `json:"previous,omitempty"`

	// Link to the next available page. If 'next' property is not part of the response no next page is available.
	Next *string `json:"next,omitempty"`

	// List of account settings templates based on the query paramters and the page size. The account_settings_templates
	// array is always part of the response but might be empty depending on the query parameter values provided.
	AccountSettingsTemplates []AccountSettingsTemplateResponse `json:"account_settings_templates" validate:"required"`
}

AccountSettingsTemplateList : AccountSettingsTemplateList struct

type AccountSettingsTemplateResponse added in v0.42.0 

type AccountSettingsTemplateResponse struct {
	// ID of the the template.
	ID *string `json:"id" validate:"required"`

	// Version of the the template.
	Version *int64 `json:"version" validate:"required"`

	// ID of the account where the template resides.
	AccountID *string `json:"account_id" validate:"required"`

	// The name of the trusted profile template. This is visible only in the enterprise account.
	Name *string `json:"name" validate:"required"`

	// The description of the trusted profile template. Describe the template for enterprise account users.
	Description *string `json:"description,omitempty"`

	// Committed flag determines if the template is ready for assignment.
	Committed *bool `json:"committed" validate:"required"`

	AccountSettings *AccountSettingsComponent `json:"account_settings" validate:"required"`

	// History of the Template.
	History []EnityHistoryRecord `json:"history,omitempty"`

	// Entity tag for this templateId-version combination.
	EntityTag *string `json:"entity_tag" validate:"required"`

	// Cloud resource name.
	CRN *string `json:"crn" validate:"required"`

	// Template Created At.
	CreatedAt *string `json:"created_at,omitempty"`

	// IAMid of the creator.
	CreatedByID *string `json:"created_by_id,omitempty"`

	// Template last modified at.
	LastModifiedAt *string `json:"last_modified_at,omitempty"`

	// IAMid of the identity that made the latest modification.
	LastModifiedByID *string `json:"last_modified_by_id,omitempty"`
}

AccountSettingsTemplateResponse : Response body format for account settings template REST requests.

type AccountSettingsUserMfa added in v0.31.0 

type AccountSettingsUserMfa struct {
	// The iam_id of the user.
	IamID *string `json:"iam_id" validate:"required"`

	// Defines the MFA requirement for the user. Valid values:
	//   * NONE - No MFA trait set
	//   * NONE_NO_ROPC- No MFA, disable CLI logins with only a password
	//   * TOTP - For all non-federated IBMId users
	//   * TOTP4ALL - For all users
	//   * LEVEL1 - Email-based MFA for all users
	//   * LEVEL2 - TOTP-based MFA for all users
	//   * LEVEL3 - U2F MFA for all users.
	Mfa *string `json:"mfa" validate:"required"`
}

AccountSettingsUserMfa : AccountSettingsUserMfa struct

type Activity added in v0.24.0 

type Activity struct {
	// Time when the entity was last authenticated.
	LastAuthn *string `json:"last_authn,omitempty"`

	// Authentication count, number of times the entity was authenticated.
	AuthnCount *int64 `json:"authn_count" validate:"required"`
}

Activity : Activity struct

type ApikeyActivity added in v0.24.1 

type ApikeyActivity struct {
	// Unique id of the apikey.
	ID *string `json:"id" validate:"required"`

	// Name provided during creation of the apikey.
	Name *string `json:"name,omitempty"`

	// Type of the apikey. Supported values are `serviceid` and `user`.
	Type *string `json:"type" validate:"required"`

	// serviceid details will be present if type is `serviceid`.
	Serviceid *ApikeyActivityServiceid `json:"serviceid,omitempty"`

	// user details will be present if type is `user`.
	User *ApikeyActivityUser `json:"user,omitempty"`

	// Time when the apikey was last authenticated.
	LastAuthn *string `json:"last_authn,omitempty"`
}

ApikeyActivity : Apikeys activity details.

type ApikeyActivityServiceid added in v0.24.1 

type ApikeyActivityServiceid struct {
	// Unique identifier of this Service Id.
	ID *string `json:"id,omitempty"`

	// Name provided during creation of the serviceid.
	Name *string `json:"name,omitempty"`
}

ApikeyActivityServiceid : serviceid details will be present if type is `serviceid`.

type ApikeyActivityUser added in v0.24.1 

type ApikeyActivityUser struct {
	// IAMid of the user.
	IamID *string `json:"iam_id,omitempty"`

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

	// Username of the user.
	Username *string `json:"username,omitempty"`

	// Email of the user.
	Email *string `json:"email,omitempty"`
}

ApikeyActivityUser : user details will be present if type is `user`.

type CommitAccountSettingsTemplateOptions added in v0.42.0 

type CommitAccountSettingsTemplateOptions struct {
	// ID of the account settings template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// Version of the account settings template.
	Version *string `json:"version" validate:"required,ne="`

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

CommitAccountSettingsTemplateOptions : The CommitAccountSettingsTemplate options.

func (*CommitAccountSettingsTemplateOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*CommitAccountSettingsTemplateOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

func (*CommitAccountSettingsTemplateOptions) SetVersion added in v0.42.0 

func (_options *CommitAccountSettingsTemplateOptions) SetVersion(version string) *CommitAccountSettingsTemplateOptions

SetVersion : Allow user to set Version

type CommitProfileTemplateOptions added in v0.42.0 

type CommitProfileTemplateOptions struct {
	// ID of the trusted profile template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// Version of the Profile Template.
	Version *string `json:"version" validate:"required,ne="`

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

CommitProfileTemplateOptions : The CommitProfileTemplate options.

func (*CommitProfileTemplateOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*CommitProfileTemplateOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

func (*CommitProfileTemplateOptions) SetVersion added in v0.42.0 

func (_options *CommitProfileTemplateOptions) SetVersion(version string) *CommitProfileTemplateOptions

SetVersion : Allow user to set Version

type CreateAPIKeyOptions added in v0.17.2 

type CreateAPIKeyOptions struct {
	// Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist.
	// Access is done via the UUID of the API key.
	Name *string `json:"name" validate:"required"`

	// The iam_id that this API key authenticates.
	IamID *string `json:"iam_id" validate:"required"`

	// The optional description of the API key. The 'description' property is only available if a description was provided
	// during a create of an API key.
	Description *string `json:"description,omitempty"`

	// The account ID of the API key.
	AccountID *string `json:"account_id,omitempty"`

	// You can optionally passthrough the API key value for this API key. If passed, a minimum length validation of 32
	// characters for that apiKey value is done, i.e. the value can contain any characters and can even be non-URL safe,
	// but the minimum length requirement must be met. If omitted, the API key management will create an URL safe opaque
	// API key value. The value of the API key is checked for uniqueness. Ensure enough variations when passing in this
	// value.
	Apikey *string `json:"apikey,omitempty"`

	// Send true or false to set whether the API key value is retrievable in the future by using the Get details of an API
	// key request. If you create an API key for a user, you must specify `false` or omit the value. We don't allow storing
	// of API keys for users.
	StoreValue *bool `json:"store_value,omitempty"`

	// Defines if the API key supports sessions. Sessions are only supported for user apikeys.
	SupportSessions *bool `json:"support_sessions,omitempty"`

	// Defines the action to take when API key is leaked, valid values are 'none', 'disable' and 'delete'.
	ActionWhenLeaked *string `json:"action_when_leaked,omitempty"`

	// Indicates if the API key is locked for further write operations. False by default.
	EntityLock *string `json:"Entity-Lock,omitempty"`

	// Indicates if the API key is disabled. False by default.
	EntityDisable *string `json:"Entity-Disable,omitempty"`

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

CreateAPIKeyOptions : The CreateAPIKey options.

func (*CreateAPIKeyOptions) SetAccountID added in v0.17.2 

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

SetAccountID : Allow user to set AccountID

func (*CreateAPIKeyOptions) SetActionWhenLeaked added in v0.62.0 

func (_options *CreateAPIKeyOptions) SetActionWhenLeaked(actionWhenLeaked string) *CreateAPIKeyOptions

SetActionWhenLeaked : Allow user to set ActionWhenLeaked

func (*CreateAPIKeyOptions) SetApikey added in v0.17.2 

func (_options *CreateAPIKeyOptions) SetApikey(apikey string) *CreateAPIKeyOptions

SetApikey : Allow user to set Apikey

func (*CreateAPIKeyOptions) SetDescription added in v0.17.2 

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

SetDescription : Allow user to set Description

func (*CreateAPIKeyOptions) SetEntityDisable added in v0.62.0 

func (_options *CreateAPIKeyOptions) SetEntityDisable(entityDisable string) *CreateAPIKeyOptions

SetEntityDisable : Allow user to set EntityDisable

func (*CreateAPIKeyOptions) SetEntityLock added in v0.17.2 

func (_options *CreateAPIKeyOptions) SetEntityLock(entityLock string) *CreateAPIKeyOptions

SetEntityLock : Allow user to set EntityLock

func (*CreateAPIKeyOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*CreateAPIKeyOptions) SetIamID added in v0.17.2 

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

SetIamID : Allow user to set IamID

func (*CreateAPIKeyOptions) SetName added in v0.17.2 

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

SetName : Allow user to set Name

func (*CreateAPIKeyOptions) SetStoreValue added in v0.17.2 

func (_options *CreateAPIKeyOptions) SetStoreValue(storeValue bool) *CreateAPIKeyOptions

SetStoreValue : Allow user to set StoreValue

func (*CreateAPIKeyOptions) SetSupportSessions added in v0.62.0 

func (_options *CreateAPIKeyOptions) SetSupportSessions(supportSessions bool) *CreateAPIKeyOptions

SetSupportSessions : Allow user to set SupportSessions

type CreateAccountSettingsAssignmentOptions added in v0.42.0 

type CreateAccountSettingsAssignmentOptions struct {
	// ID of the template to assign.
	TemplateID *string `json:"template_id" validate:"required"`

	// Version of the template to assign.
	TemplateVersion *int64 `json:"template_version" validate:"required"`

	// Type of target to deploy to.
	TargetType *string `json:"target_type" validate:"required"`

	// Identifier of target to deploy to.
	Target *string `json:"target" validate:"required"`

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

CreateAccountSettingsAssignmentOptions : The CreateAccountSettingsAssignment options.

func (*CreateAccountSettingsAssignmentOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*CreateAccountSettingsAssignmentOptions) SetTarget added in v0.42.0 

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

SetTarget : Allow user to set Target

func (*CreateAccountSettingsAssignmentOptions) SetTargetType added in v0.42.0 

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

SetTargetType : Allow user to set TargetType

func (*CreateAccountSettingsAssignmentOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

func (*CreateAccountSettingsAssignmentOptions) SetTemplateVersion added in v0.42.0 

func (_options *CreateAccountSettingsAssignmentOptions) SetTemplateVersion(templateVersion int64) *CreateAccountSettingsAssignmentOptions

SetTemplateVersion : Allow user to set TemplateVersion

type CreateAccountSettingsTemplateOptions added in v0.42.0 

type CreateAccountSettingsTemplateOptions struct {
	// ID of the account where the template resides.
	AccountID *string `json:"account_id,omitempty"`

	// The name of the trusted profile template. This is visible only in the enterprise account.
	Name *string `json:"name,omitempty"`

	// The description of the trusted profile template. Describe the template for enterprise account users.
	Description *string `json:"description,omitempty"`

	AccountSettings *AccountSettingsComponent `json:"account_settings,omitempty"`

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

CreateAccountSettingsTemplateOptions : The CreateAccountSettingsTemplate options.

func (*CreateAccountSettingsTemplateOptions) SetAccountID added in v0.42.0 

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

SetAccountID : Allow user to set AccountID

func (*CreateAccountSettingsTemplateOptions) SetAccountSettings added in v0.42.0 

func (_options *CreateAccountSettingsTemplateOptions) SetAccountSettings(accountSettings *AccountSettingsComponent) *CreateAccountSettingsTemplateOptions

SetAccountSettings : Allow user to set AccountSettings

func (*CreateAccountSettingsTemplateOptions) SetDescription added in v0.42.0 

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

SetDescription : Allow user to set Description

func (*CreateAccountSettingsTemplateOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*CreateAccountSettingsTemplateOptions) SetName added in v0.42.0 

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

SetName : Allow user to set Name

type CreateAccountSettingsTemplateVersionOptions added in v0.42.0 

type CreateAccountSettingsTemplateVersionOptions struct {
	// ID of the account settings template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// ID of the account where the template resides.
	AccountID *string `json:"account_id,omitempty"`

	// The name of the trusted profile template. This is visible only in the enterprise account.
	Name *string `json:"name,omitempty"`

	// The description of the trusted profile template. Describe the template for enterprise account users.
	Description *string `json:"description,omitempty"`

	AccountSettings *AccountSettingsComponent `json:"account_settings,omitempty"`

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

CreateAccountSettingsTemplateVersionOptions : The CreateAccountSettingsTemplateVersion options.

func (*CreateAccountSettingsTemplateVersionOptions) SetAccountID added in v0.42.0 

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

SetAccountID : Allow user to set AccountID

func (*CreateAccountSettingsTemplateVersionOptions) SetAccountSettings added in v0.42.0 

func (_options *CreateAccountSettingsTemplateVersionOptions) SetAccountSettings(accountSettings *AccountSettingsComponent) *CreateAccountSettingsTemplateVersionOptions

SetAccountSettings : Allow user to set AccountSettings

func (*CreateAccountSettingsTemplateVersionOptions) SetDescription added in v0.42.0 

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

SetDescription : Allow user to set Description

func (*CreateAccountSettingsTemplateVersionOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*CreateAccountSettingsTemplateVersionOptions) SetName added in v0.42.0 

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

SetName : Allow user to set Name

func (*CreateAccountSettingsTemplateVersionOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

type CreateClaimRuleOptions added in v0.20.0 

type CreateClaimRuleOptions struct {
	// ID of the trusted profile to create a claim rule.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

	// Type of the claim rule, either 'Profile-SAML' or 'Profile-CR'.
	Type *string `json:"type" validate:"required"`

	// Conditions of this claim rule.
	Conditions []ProfileClaimRuleConditions `json:"conditions" validate:"required"`

	// Context with key properties for problem determination.
	Context *ResponseContext `json:"context,omitempty"`

	// Name of the claim rule to be created or updated.
	Name *string `json:"name,omitempty"`

	// The realm name of the Idp this claim rule applies to. This field is required only if the type is specified as
	// 'Profile-SAML'.
	RealmName *string `json:"realm_name,omitempty"`

	// The compute resource type the rule applies to, required only if type is specified as 'Profile-CR'. Valid values are
	// VSI, IKS_SA, ROKS_SA.
	CrType *string `json:"cr_type,omitempty"`

	// Session expiration in seconds, only required if type is 'Profile-SAML'.
	Expiration *int64 `json:"expiration,omitempty"`

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

CreateClaimRuleOptions : The CreateClaimRule options.

func (*CreateClaimRuleOptions) SetConditions added in v0.20.0 

func (_options *CreateClaimRuleOptions) SetConditions(conditions []ProfileClaimRuleConditions) *CreateClaimRuleOptions

SetConditions : Allow user to set Conditions

func (*CreateClaimRuleOptions) SetContext added in v0.20.0 

func (_options *CreateClaimRuleOptions) SetContext(context *ResponseContext) *CreateClaimRuleOptions

SetContext : Allow user to set Context

func (*CreateClaimRuleOptions) SetCrType added in v0.20.0 

func (_options *CreateClaimRuleOptions) SetCrType(crType string) *CreateClaimRuleOptions

SetCrType : Allow user to set CrType

func (*CreateClaimRuleOptions) SetExpiration added in v0.20.0 

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

SetExpiration : Allow user to set Expiration

func (*CreateClaimRuleOptions) SetHeaders added in v0.20.0 

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

SetHeaders : Allow user to set Headers

func (*CreateClaimRuleOptions) SetName added in v0.20.0 

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

SetName : Allow user to set Name

func (*CreateClaimRuleOptions) SetProfileID added in v0.20.0 

func (_options *CreateClaimRuleOptions) SetProfileID(profileID string) *CreateClaimRuleOptions

SetProfileID : Allow user to set ProfileID

func (*CreateClaimRuleOptions) SetRealmName added in v0.20.0 

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

SetRealmName : Allow user to set RealmName

func (*CreateClaimRuleOptions) SetType added in v0.20.0 

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

SetType : Allow user to set Type

type CreateLinkOptions added in v0.20.0 

type CreateLinkOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

	// The compute resource type. Valid values are VSI, IKS_SA, ROKS_SA.
	CrType *string `json:"cr_type" validate:"required"`

	// Link details.
	Link *CreateProfileLinkRequestLink `json:"link" validate:"required"`

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

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

CreateLinkOptions : The CreateLink options.

func (*CreateLinkOptions) SetCrType added in v0.20.0 

func (_options *CreateLinkOptions) SetCrType(crType string) *CreateLinkOptions

SetCrType : Allow user to set CrType

func (*CreateLinkOptions) SetHeaders added in v0.20.0 

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

SetHeaders : Allow user to set Headers 

func (_options *CreateLinkOptions) SetLink(link *CreateProfileLinkRequestLink) *CreateLinkOptions

SetLink : Allow user to set Link

func (*CreateLinkOptions) SetName added in v0.20.0 

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

SetName : Allow user to set Name

func (*CreateLinkOptions) SetProfileID added in v0.20.0 

func (_options *CreateLinkOptions) SetProfileID(profileID string) *CreateLinkOptions

SetProfileID : Allow user to set ProfileID

type CreateMfaReportOptions added in v0.31.6 

type CreateMfaReportOptions struct {
	// ID of the account.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// Optional report type. The supported value is 'mfa_status'. List MFA enrollment status for all the identities.
	Type *string `json:"type,omitempty"`

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

CreateMfaReportOptions : The CreateMfaReport options.

func (*CreateMfaReportOptions) SetAccountID added in v0.31.6 

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

SetAccountID : Allow user to set AccountID

func (*CreateMfaReportOptions) SetHeaders added in v0.31.6 

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

SetHeaders : Allow user to set Headers

func (*CreateMfaReportOptions) SetType added in v0.31.6 

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

SetType : Allow user to set Type 

type CreateProfileLinkRequestLink struct {
	// The CRN of the compute resource.
	CRN *string `json:"crn" validate:"required"`

	// The compute resource namespace, only required if cr_type is IKS_SA or ROKS_SA.
	Namespace *string `json:"namespace" validate:"required"`

	// Name of the compute resource, only required if cr_type is IKS_SA or ROKS_SA.
	Name *string `json:"name,omitempty"`
}

CreateProfileLinkRequestLink : Link details.

type CreateProfileOptions added in v0.20.0 

type CreateProfileOptions struct {
	// Name of the trusted profile. The name is checked for uniqueness. Therefore trusted profiles with the same names can
	// not exist in the same account.
	Name *string `json:"name" validate:"required"`

	// The account ID of the trusted profile.
	AccountID *string `json:"account_id" validate:"required"`

	// The optional description of the trusted profile. The 'description' property is only available if a description was
	// provided during creation of trusted profile.
	Description *string `json:"description,omitempty"`

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

CreateProfileOptions : The CreateProfile options.

func (*CreateProfileOptions) SetAccountID added in v0.20.0 

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

SetAccountID : Allow user to set AccountID

func (*CreateProfileOptions) SetDescription added in v0.20.0 

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

SetDescription : Allow user to set Description

func (*CreateProfileOptions) SetHeaders added in v0.20.0 

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

SetHeaders : Allow user to set Headers

func (*CreateProfileOptions) SetName added in v0.20.0 

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

SetName : Allow user to set Name

type CreateProfileTemplateOptions added in v0.42.0 

type CreateProfileTemplateOptions struct {
	// ID of the account where the template resides.
	AccountID *string `json:"account_id,omitempty"`

	// The name of the trusted profile template. This is visible only in the enterprise account. Required field when
	// creating a new template. Otherwise this field is optional. If the field is included it will change the name value
	// for all existing versions of the template.
	Name *string `json:"name,omitempty"`

	// The description of the trusted profile template. Describe the template for enterprise account users.
	Description *string `json:"description,omitempty"`

	// Input body parameters for the TemplateProfileComponent.
	Profile *TemplateProfileComponentRequest `json:"profile,omitempty"`

	// Existing policy templates that you can reference to assign access in the trusted profile component.
	PolicyTemplateReferences []PolicyTemplateReference `json:"policy_template_references,omitempty"`

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

CreateProfileTemplateOptions : The CreateProfileTemplate options.

func (*CreateProfileTemplateOptions) SetAccountID added in v0.42.0 

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

SetAccountID : Allow user to set AccountID

func (*CreateProfileTemplateOptions) SetDescription added in v0.42.0 

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

SetDescription : Allow user to set Description

func (*CreateProfileTemplateOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*CreateProfileTemplateOptions) SetName added in v0.42.0 

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

SetName : Allow user to set Name

func (*CreateProfileTemplateOptions) SetPolicyTemplateReferences added in v0.42.0 

func (_options *CreateProfileTemplateOptions) SetPolicyTemplateReferences(policyTemplateReferences []PolicyTemplateReference) *CreateProfileTemplateOptions

SetPolicyTemplateReferences : Allow user to set PolicyTemplateReferences

func (*CreateProfileTemplateOptions) SetProfile added in v0.42.0 

func (_options *CreateProfileTemplateOptions) SetProfile(profile *TemplateProfileComponentRequest) *CreateProfileTemplateOptions

SetProfile : Allow user to set Profile

type CreateProfileTemplateVersionOptions added in v0.42.0 

type CreateProfileTemplateVersionOptions struct {
	// ID of the trusted profile template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// ID of the account where the template resides.
	AccountID *string `json:"account_id,omitempty"`

	// The name of the trusted profile template. This is visible only in the enterprise account. Required field when
	// creating a new template. Otherwise this field is optional. If the field is included it will change the name value
	// for all existing versions of the template.
	Name *string `json:"name,omitempty"`

	// The description of the trusted profile template. Describe the template for enterprise account users.
	Description *string `json:"description,omitempty"`

	// Input body parameters for the TemplateProfileComponent.
	Profile *TemplateProfileComponentRequest `json:"profile,omitempty"`

	// Existing policy templates that you can reference to assign access in the trusted profile component.
	PolicyTemplateReferences []PolicyTemplateReference `json:"policy_template_references,omitempty"`

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

CreateProfileTemplateVersionOptions : The CreateProfileTemplateVersion options.

func (*CreateProfileTemplateVersionOptions) SetAccountID added in v0.42.0 

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

SetAccountID : Allow user to set AccountID

func (*CreateProfileTemplateVersionOptions) SetDescription added in v0.42.0 

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

SetDescription : Allow user to set Description

func (*CreateProfileTemplateVersionOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*CreateProfileTemplateVersionOptions) SetName added in v0.42.0 

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

SetName : Allow user to set Name

func (*CreateProfileTemplateVersionOptions) SetPolicyTemplateReferences added in v0.42.0 

func (_options *CreateProfileTemplateVersionOptions) SetPolicyTemplateReferences(policyTemplateReferences []PolicyTemplateReference) *CreateProfileTemplateVersionOptions

SetPolicyTemplateReferences : Allow user to set PolicyTemplateReferences

func (*CreateProfileTemplateVersionOptions) SetProfile added in v0.42.0 

func (_options *CreateProfileTemplateVersionOptions) SetProfile(profile *TemplateProfileComponentRequest) *CreateProfileTemplateVersionOptions

SetProfile : Allow user to set Profile

func (*CreateProfileTemplateVersionOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

type CreateReportOptions added in v0.24.0 

type CreateReportOptions struct {
	// ID of the account.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// Optional report type. The supported value is 'inactive'. List all identities that have not authenticated within the
	// time indicated by duration.
	Type *string `json:"type,omitempty"`

	// Optional duration of the report. The supported unit of duration is hours.
	Duration *string `json:"duration,omitempty"`

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

CreateReportOptions : The CreateReport options.

func (*CreateReportOptions) SetAccountID added in v0.24.0 

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

SetAccountID : Allow user to set AccountID

func (*CreateReportOptions) SetDuration added in v0.24.0 

func (_options *CreateReportOptions) SetDuration(duration string) *CreateReportOptions

SetDuration : Allow user to set Duration

func (*CreateReportOptions) SetHeaders added in v0.24.0 

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

SetHeaders : Allow user to set Headers

func (*CreateReportOptions) SetType added in v0.24.0 

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

SetType : Allow user to set Type

type CreateServiceIDOptions added in v0.17.2 

type CreateServiceIDOptions struct {
	// ID of the account the service ID belongs to.
	AccountID *string `json:"account_id" validate:"required"`

	// Name of the Service Id. The name is not checked for uniqueness. Therefore multiple names with the same value can
	// exist. Access is done via the UUID of the Service Id.
	Name *string `json:"name" validate:"required"`

	// The optional description of the Service Id. The 'description' property is only available if a description was
	// provided during a create of a Service Id.
	Description *string `json:"description,omitempty"`

	// Optional list of CRNs (string array) which point to the services connected to the service ID.
	UniqueInstanceCrns []string `json:"unique_instance_crns,omitempty"`

	// Parameters for the API key in the Create service Id V1 REST request.
	Apikey *APIKeyInsideCreateServiceIDRequest `json:"apikey,omitempty"`

	// Indicates if the service ID is locked for further write operations. False by default.
	EntityLock *string `json:"Entity-Lock,omitempty"`

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

CreateServiceIDOptions : The CreateServiceID options.

func (*CreateServiceIDOptions) SetAccountID added in v0.17.2 

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

SetAccountID : Allow user to set AccountID

func (*CreateServiceIDOptions) SetApikey added in v0.17.2 

func (_options *CreateServiceIDOptions) SetApikey(apikey *APIKeyInsideCreateServiceIDRequest) *CreateServiceIDOptions

SetApikey : Allow user to set Apikey

func (*CreateServiceIDOptions) SetDescription added in v0.17.2 

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

SetDescription : Allow user to set Description

func (*CreateServiceIDOptions) SetEntityLock added in v0.17.2 

func (_options *CreateServiceIDOptions) SetEntityLock(entityLock string) *CreateServiceIDOptions

SetEntityLock : Allow user to set EntityLock

func (*CreateServiceIDOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*CreateServiceIDOptions) SetName added in v0.17.2 

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

SetName : Allow user to set Name

func (*CreateServiceIDOptions) SetUniqueInstanceCrns added in v0.17.2 

func (_options *CreateServiceIDOptions) SetUniqueInstanceCrns(uniqueInstanceCrns []string) *CreateServiceIDOptions

SetUniqueInstanceCrns : Allow user to set UniqueInstanceCrns

type CreateTrustedProfileAssignmentOptions added in v0.42.0 

type CreateTrustedProfileAssignmentOptions struct {
	// ID of the template to assign.
	TemplateID *string `json:"template_id" validate:"required"`

	// Version of the template to assign.
	TemplateVersion *int64 `json:"template_version" validate:"required"`

	// Type of target to deploy to.
	TargetType *string `json:"target_type" validate:"required"`

	// Identifier of target to deploy to.
	Target *string `json:"target" validate:"required"`

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

CreateTrustedProfileAssignmentOptions : The CreateTrustedProfileAssignment options.

func (*CreateTrustedProfileAssignmentOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*CreateTrustedProfileAssignmentOptions) SetTarget added in v0.42.0 

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

SetTarget : Allow user to set Target

func (*CreateTrustedProfileAssignmentOptions) SetTargetType added in v0.42.0 

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

SetTargetType : Allow user to set TargetType

func (*CreateTrustedProfileAssignmentOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

func (*CreateTrustedProfileAssignmentOptions) SetTemplateVersion added in v0.42.0 

func (_options *CreateTrustedProfileAssignmentOptions) SetTemplateVersion(templateVersion int64) *CreateTrustedProfileAssignmentOptions

SetTemplateVersion : Allow user to set TemplateVersion

type DeleteAPIKeyOptions added in v0.17.2 

type DeleteAPIKeyOptions struct {
	// Unique ID of the API key.
	ID *string `json:"id" validate:"required,ne="`

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

DeleteAPIKeyOptions : The DeleteAPIKey options.

func (*DeleteAPIKeyOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*DeleteAPIKeyOptions) SetID added in v0.17.2 

func (_options *DeleteAPIKeyOptions) SetID(id string) *DeleteAPIKeyOptions

SetID : Allow user to set ID

type DeleteAccountSettingsAssignmentOptions added in v0.42.0 

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

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

DeleteAccountSettingsAssignmentOptions : The DeleteAccountSettingsAssignment options.

func (*DeleteAccountSettingsAssignmentOptions) SetAssignmentID added in v0.42.0 

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

SetAssignmentID : Allow user to set AssignmentID

func (*DeleteAccountSettingsAssignmentOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

type DeleteAccountSettingsTemplateVersionOptions added in v0.42.0 

type DeleteAccountSettingsTemplateVersionOptions struct {
	// ID of the account settings template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// Version of the account settings template.
	Version *string `json:"version" validate:"required,ne="`

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

DeleteAccountSettingsTemplateVersionOptions : The DeleteAccountSettingsTemplateVersion options.

func (*DeleteAccountSettingsTemplateVersionOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*DeleteAccountSettingsTemplateVersionOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

func (*DeleteAccountSettingsTemplateVersionOptions) SetVersion added in v0.42.0 

func (_options *DeleteAccountSettingsTemplateVersionOptions) SetVersion(version string) *DeleteAccountSettingsTemplateVersionOptions

SetVersion : Allow user to set Version

type DeleteAllVersionsOfAccountSettingsTemplateOptions added in v0.42.0 

type DeleteAllVersionsOfAccountSettingsTemplateOptions struct {
	// ID of the account settings template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

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

DeleteAllVersionsOfAccountSettingsTemplateOptions : The DeleteAllVersionsOfAccountSettingsTemplate options.

func (*DeleteAllVersionsOfAccountSettingsTemplateOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*DeleteAllVersionsOfAccountSettingsTemplateOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

type DeleteAllVersionsOfProfileTemplateOptions added in v0.42.0 

type DeleteAllVersionsOfProfileTemplateOptions struct {
	// ID of the trusted profile template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

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

DeleteAllVersionsOfProfileTemplateOptions : The DeleteAllVersionsOfProfileTemplate options.

func (*DeleteAllVersionsOfProfileTemplateOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*DeleteAllVersionsOfProfileTemplateOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

type DeleteClaimRuleOptions added in v0.20.0 

type DeleteClaimRuleOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

	// ID of the claim rule to delete.
	RuleID *string `json:"rule-id" validate:"required,ne="`

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

DeleteClaimRuleOptions : The DeleteClaimRule options.

func (*DeleteClaimRuleOptions) SetHeaders added in v0.20.0 

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

SetHeaders : Allow user to set Headers

func (*DeleteClaimRuleOptions) SetProfileID added in v0.20.0 

func (_options *DeleteClaimRuleOptions) SetProfileID(profileID string) *DeleteClaimRuleOptions

SetProfileID : Allow user to set ProfileID

func (*DeleteClaimRuleOptions) SetRuleID added in v0.20.0 

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

SetRuleID : Allow user to set RuleID

type DeleteLinkOptions added in v0.20.0 

type DeleteLinkOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

	// ID of the link.
	LinkID *string `json:"link-id" validate:"required,ne="`

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

DeleteLinkOptions : The DeleteLink options.

func (*DeleteLinkOptions) SetHeaders added in v0.20.0 

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

SetHeaders : Allow user to set Headers

func (*DeleteLinkOptions) SetLinkID added in v0.20.0 

func (_options *DeleteLinkOptions) SetLinkID(linkID string) *DeleteLinkOptions

SetLinkID : Allow user to set LinkID

func (*DeleteLinkOptions) SetProfileID added in v0.20.0 

func (_options *DeleteLinkOptions) SetProfileID(profileID string) *DeleteLinkOptions

SetProfileID : Allow user to set ProfileID

type DeleteProfileIdentityOptions added in v0.40.0 

type DeleteProfileIdentityOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

	// Type of the identity.
	IdentityType *string `json:"identity-type" validate:"required,ne="`

	// Identifier of the identity that can assume the trusted profiles.
	IdentifierID *string `json:"identifier-id" validate:"required,ne="`

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

DeleteProfileIdentityOptions : The DeleteProfileIdentity options.

func (*DeleteProfileIdentityOptions) SetHeaders added in v0.40.0 

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

SetHeaders : Allow user to set Headers

func (*DeleteProfileIdentityOptions) SetIdentifierID added in v0.40.0 

func (_options *DeleteProfileIdentityOptions) SetIdentifierID(identifierID string) *DeleteProfileIdentityOptions

SetIdentifierID : Allow user to set IdentifierID

func (*DeleteProfileIdentityOptions) SetIdentityType added in v0.40.0 

func (_options *DeleteProfileIdentityOptions) SetIdentityType(identityType string) *DeleteProfileIdentityOptions

SetIdentityType : Allow user to set IdentityType

func (*DeleteProfileIdentityOptions) SetProfileID added in v0.40.0 

func (_options *DeleteProfileIdentityOptions) SetProfileID(profileID string) *DeleteProfileIdentityOptions

SetProfileID : Allow user to set ProfileID

type DeleteProfileOptions added in v0.20.0 

type DeleteProfileOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

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

DeleteProfileOptions : The DeleteProfile options.

func (*DeleteProfileOptions) SetHeaders added in v0.20.0 

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

SetHeaders : Allow user to set Headers

func (*DeleteProfileOptions) SetProfileID added in v0.20.0 

func (_options *DeleteProfileOptions) SetProfileID(profileID string) *DeleteProfileOptions

SetProfileID : Allow user to set ProfileID

type DeleteProfileTemplateVersionOptions added in v0.42.0 

type DeleteProfileTemplateVersionOptions struct {
	// ID of the trusted profile template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// Version of the Profile Template.
	Version *string `json:"version" validate:"required,ne="`

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

DeleteProfileTemplateVersionOptions : The DeleteProfileTemplateVersion options.

func (*DeleteProfileTemplateVersionOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*DeleteProfileTemplateVersionOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

func (*DeleteProfileTemplateVersionOptions) SetVersion added in v0.42.0 

func (_options *DeleteProfileTemplateVersionOptions) SetVersion(version string) *DeleteProfileTemplateVersionOptions

SetVersion : Allow user to set Version

type DeleteServiceIDOptions added in v0.17.2 

type DeleteServiceIDOptions struct {
	// Unique ID of the service ID.
	ID *string `json:"id" validate:"required,ne="`

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

DeleteServiceIDOptions : The DeleteServiceID options.

func (*DeleteServiceIDOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*DeleteServiceIDOptions) SetID added in v0.17.2 

func (_options *DeleteServiceIDOptions) SetID(id string) *DeleteServiceIDOptions

SetID : Allow user to set ID

type DeleteTrustedProfileAssignmentOptions added in v0.42.0 

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

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

DeleteTrustedProfileAssignmentOptions : The DeleteTrustedProfileAssignment options.

func (*DeleteTrustedProfileAssignmentOptions) SetAssignmentID added in v0.42.0 

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

SetAssignmentID : Allow user to set AssignmentID

func (*DeleteTrustedProfileAssignmentOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

type DisableAPIKeyOptions added in v0.62.0 

type DisableAPIKeyOptions struct {
	// Unique ID of the API key.
	ID *string `json:"id" validate:"required,ne="`

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

DisableAPIKeyOptions : The DisableAPIKey options.

func (*DisableAPIKeyOptions) SetHeaders added in v0.62.0 

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

SetHeaders : Allow user to set Headers

func (*DisableAPIKeyOptions) SetID added in v0.62.0 

func (_options *DisableAPIKeyOptions) SetID(id string) *DisableAPIKeyOptions

SetID : Allow user to set ID

type EnableAPIKeyOptions added in v0.62.0 

type EnableAPIKeyOptions struct {
	// Unique ID of the API key.
	ID *string `json:"id" validate:"required,ne="`

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

EnableAPIKeyOptions : The EnableAPIKey options.

func (*EnableAPIKeyOptions) SetHeaders added in v0.62.0 

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

SetHeaders : Allow user to set Headers

func (*EnableAPIKeyOptions) SetID added in v0.62.0 

func (_options *EnableAPIKeyOptions) SetID(id string) *EnableAPIKeyOptions

SetID : Allow user to set ID

type EnityHistoryRecord 

type EnityHistoryRecord struct {
	// Timestamp when the action was triggered.
	Timestamp *string `json:"timestamp" validate:"required"`

	// IAM ID of the identity which triggered the action.
	IamID *string `json:"iam_id" validate:"required"`

	// Account of the identity which triggered the action.
	IamIDAccount *string `json:"iam_id_account" validate:"required"`

	// Action of the history entry.
	Action *string `json:"action" validate:"required"`

	// Params of the history entry.
	Params []string `json:"params" validate:"required"`

	// Message which summarizes the executed action.
	Message *string `json:"message" validate:"required"`
}

EnityHistoryRecord : Response body format for an entity history record.

type EntityActivity added in v0.24.0 

type EntityActivity struct {
	// Unique id of the entity.
	ID *string `json:"id" validate:"required"`

	// Name provided during creation of the entity.
	Name *string `json:"name,omitempty"`

	// Time when the entity was last authenticated.
	LastAuthn *string `json:"last_authn,omitempty"`
}

EntityActivity : EntityActivity struct

type Error added in v0.42.0 

type Error struct {
	// Error code of the REST Exception.
	Code *string `json:"code" validate:"required"`

	// Error message code of the REST Exception.
	MessageCode *string `json:"message_code" validate:"required"`

	// Error message of the REST Exception. Error messages are derived base on the input locale of the REST request and the
	// available Message catalogs. Dynamic fallback to 'us-english' is happening if no message catalog is available for the
	// provided input locale.
	Message *string `json:"message" validate:"required"`

	// Error details of the REST Exception.
	Details *string `json:"details,omitempty"`
}

Error : Error information.

type ExceptionResponse added in v0.42.0 

type ExceptionResponse struct {
	// Context with key properties for problem determination.
	Context *ResponseContext `json:"context,omitempty"`

	// Error message code of the REST Exception.
	StatusCode *string `json:"status_code" validate:"required"`

	// List of errors that occured.
	Errors []Error `json:"errors" validate:"required"`

	// Unique ID of the requst.
	Trace *string `json:"trace,omitempty"`
}

ExceptionResponse : Response body parameters in case of error situations.

type GetAPIKeyOptions added in v0.17.2 

type GetAPIKeyOptions struct {
	// Unique ID of the API key.
	ID *string `json:"id" validate:"required,ne="`

	// Defines if the entity history is included in the response.
	IncludeHistory *bool `json:"include_history,omitempty"`

	// Defines if the entity's activity is included in the response. Retrieving activity data is an expensive operation, so
	// only request this when needed.
	IncludeActivity *bool `json:"include_activity,omitempty"`

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

GetAPIKeyOptions : The GetAPIKey options.

func (*GetAPIKeyOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*GetAPIKeyOptions) SetID added in v0.17.2 

func (_options *GetAPIKeyOptions) SetID(id string) *GetAPIKeyOptions

SetID : Allow user to set ID

func (*GetAPIKeyOptions) SetIncludeActivity added in v0.24.0 

func (_options *GetAPIKeyOptions) SetIncludeActivity(includeActivity bool) *GetAPIKeyOptions

SetIncludeActivity : Allow user to set IncludeActivity

func (*GetAPIKeyOptions) SetIncludeHistory added in v0.17.2 

func (_options *GetAPIKeyOptions) SetIncludeHistory(includeHistory bool) *GetAPIKeyOptions

SetIncludeHistory : Allow user to set IncludeHistory

type GetAPIKeysDetailsOptions added in v0.17.2 

type GetAPIKeysDetailsOptions struct {
	// API key value.
	IamAPIKey *string `json:"IAM-ApiKey,omitempty"`

	// Defines if the entity history is included in the response.
	IncludeHistory *bool `json:"include_history,omitempty"`

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

GetAPIKeysDetailsOptions : The GetAPIKeysDetails options.

func (*GetAPIKeysDetailsOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*GetAPIKeysDetailsOptions) SetIamAPIKey added in v0.17.2 

func (_options *GetAPIKeysDetailsOptions) SetIamAPIKey(iamAPIKey string) *GetAPIKeysDetailsOptions

SetIamAPIKey : Allow user to set IamAPIKey

func (*GetAPIKeysDetailsOptions) SetIncludeHistory added in v0.17.2 

func (_options *GetAPIKeysDetailsOptions) SetIncludeHistory(includeHistory bool) *GetAPIKeysDetailsOptions

SetIncludeHistory : Allow user to set IncludeHistory

type GetAccountSettingsAssignmentOptions added in v0.42.0 

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

	// Defines if the entity history is included in the response.
	IncludeHistory *bool `json:"include_history,omitempty"`

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

GetAccountSettingsAssignmentOptions : The GetAccountSettingsAssignment options.

func (*GetAccountSettingsAssignmentOptions) SetAssignmentID added in v0.42.0 

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

SetAssignmentID : Allow user to set AssignmentID

func (*GetAccountSettingsAssignmentOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*GetAccountSettingsAssignmentOptions) SetIncludeHistory added in v0.42.0 

func (_options *GetAccountSettingsAssignmentOptions) SetIncludeHistory(includeHistory bool) *GetAccountSettingsAssignmentOptions

SetIncludeHistory : Allow user to set IncludeHistory

type GetAccountSettingsOptions added in v0.17.17 

type GetAccountSettingsOptions struct {
	// Unique ID of the account.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// Defines if the entity history is included in the response.
	IncludeHistory *bool `json:"include_history,omitempty"`

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

GetAccountSettingsOptions : The GetAccountSettings options.

func (*GetAccountSettingsOptions) SetAccountID added in v0.17.17 

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

SetAccountID : Allow user to set AccountID

func (*GetAccountSettingsOptions) SetHeaders added in v0.17.17 

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

SetHeaders : Allow user to set Headers

func (*GetAccountSettingsOptions) SetIncludeHistory added in v0.17.17 

func (_options *GetAccountSettingsOptions) SetIncludeHistory(includeHistory bool) *GetAccountSettingsOptions

SetIncludeHistory : Allow user to set IncludeHistory

type GetAccountSettingsTemplateVersionOptions added in v0.42.0 

type GetAccountSettingsTemplateVersionOptions struct {
	// ID of the account settings template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// Version of the account settings template.
	Version *string `json:"version" validate:"required,ne="`

	// Defines if the entity history is included in the response.
	IncludeHistory *bool `json:"include_history,omitempty"`

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

GetAccountSettingsTemplateVersionOptions : The GetAccountSettingsTemplateVersion options.

func (*GetAccountSettingsTemplateVersionOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*GetAccountSettingsTemplateVersionOptions) SetIncludeHistory added in v0.42.0 

func (_options *GetAccountSettingsTemplateVersionOptions) SetIncludeHistory(includeHistory bool) *GetAccountSettingsTemplateVersionOptions

SetIncludeHistory : Allow user to set IncludeHistory

func (*GetAccountSettingsTemplateVersionOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

func (*GetAccountSettingsTemplateVersionOptions) SetVersion added in v0.42.0 

func (_options *GetAccountSettingsTemplateVersionOptions) SetVersion(version string) *GetAccountSettingsTemplateVersionOptions

SetVersion : Allow user to set Version

type GetClaimRuleOptions added in v0.20.0 

type GetClaimRuleOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

	// ID of the claim rule to get.
	RuleID *string `json:"rule-id" validate:"required,ne="`

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

GetClaimRuleOptions : The GetClaimRule options.

func (*GetClaimRuleOptions) SetHeaders added in v0.20.0 

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

SetHeaders : Allow user to set Headers

func (*GetClaimRuleOptions) SetProfileID added in v0.20.0 

func (_options *GetClaimRuleOptions) SetProfileID(profileID string) *GetClaimRuleOptions

SetProfileID : Allow user to set ProfileID

func (*GetClaimRuleOptions) SetRuleID added in v0.20.0 

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

SetRuleID : Allow user to set RuleID

type GetLatestAccountSettingsTemplateVersionOptions added in v0.42.0 

type GetLatestAccountSettingsTemplateVersionOptions struct {
	// ID of the account settings template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// Defines if the entity history is included in the response.
	IncludeHistory *bool `json:"include_history,omitempty"`

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

GetLatestAccountSettingsTemplateVersionOptions : The GetLatestAccountSettingsTemplateVersion options.

func (*GetLatestAccountSettingsTemplateVersionOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*GetLatestAccountSettingsTemplateVersionOptions) SetIncludeHistory added in v0.42.0 

func (_options *GetLatestAccountSettingsTemplateVersionOptions) SetIncludeHistory(includeHistory bool) *GetLatestAccountSettingsTemplateVersionOptions

SetIncludeHistory : Allow user to set IncludeHistory

func (*GetLatestAccountSettingsTemplateVersionOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

type GetLatestProfileTemplateVersionOptions added in v0.42.0 

type GetLatestProfileTemplateVersionOptions struct {
	// ID of the trusted profile template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// Defines if the entity history is included in the response.
	IncludeHistory *bool `json:"include_history,omitempty"`

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

GetLatestProfileTemplateVersionOptions : The GetLatestProfileTemplateVersion options.

func (*GetLatestProfileTemplateVersionOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*GetLatestProfileTemplateVersionOptions) SetIncludeHistory added in v0.42.0 

func (_options *GetLatestProfileTemplateVersionOptions) SetIncludeHistory(includeHistory bool) *GetLatestProfileTemplateVersionOptions

SetIncludeHistory : Allow user to set IncludeHistory

func (*GetLatestProfileTemplateVersionOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

type GetLinkOptions added in v0.20.0 

type GetLinkOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

	// ID of the link.
	LinkID *string `json:"link-id" validate:"required,ne="`

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

GetLinkOptions : The GetLink options.

func (*GetLinkOptions) SetHeaders added in v0.20.0 

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

SetHeaders : Allow user to set Headers

func (*GetLinkOptions) SetLinkID added in v0.20.0 

func (_options *GetLinkOptions) SetLinkID(linkID string) *GetLinkOptions

SetLinkID : Allow user to set LinkID

func (*GetLinkOptions) SetProfileID added in v0.20.0 

func (_options *GetLinkOptions) SetProfileID(profileID string) *GetLinkOptions

SetProfileID : Allow user to set ProfileID

type GetMfaReportOptions added in v0.31.6 

type GetMfaReportOptions struct {
	// ID of the account.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// Reference for the report to be generated, You can use 'latest' to get the latest report for the given account.
	Reference *string `json:"reference" validate:"required,ne="`

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

GetMfaReportOptions : The GetMfaReport options.

func (*GetMfaReportOptions) SetAccountID added in v0.31.6 

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

SetAccountID : Allow user to set AccountID

func (*GetMfaReportOptions) SetHeaders added in v0.31.6 

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

SetHeaders : Allow user to set Headers

func (*GetMfaReportOptions) SetReference added in v0.31.6 

func (_options *GetMfaReportOptions) SetReference(reference string) *GetMfaReportOptions

SetReference : Allow user to set Reference

type GetMfaStatusOptions added in v0.31.6 

type GetMfaStatusOptions struct {
	// ID of the account.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// iam_id of the user. This user must be the member of the account.
	IamID *string `json:"iam_id" validate:"required"`

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

GetMfaStatusOptions : The GetMfaStatus options.

func (*GetMfaStatusOptions) SetAccountID added in v0.31.6 

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

SetAccountID : Allow user to set AccountID

func (*GetMfaStatusOptions) SetHeaders added in v0.31.6 

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

SetHeaders : Allow user to set Headers

func (*GetMfaStatusOptions) SetIamID added in v0.31.6 

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

SetIamID : Allow user to set IamID

type GetProfileIdentitiesOptions added in v0.40.0 

type GetProfileIdentitiesOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

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

GetProfileIdentitiesOptions : The GetProfileIdentities options.

func (*GetProfileIdentitiesOptions) SetHeaders added in v0.40.0 

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

SetHeaders : Allow user to set Headers

func (*GetProfileIdentitiesOptions) SetProfileID added in v0.40.0 

func (_options *GetProfileIdentitiesOptions) SetProfileID(profileID string) *GetProfileIdentitiesOptions

SetProfileID : Allow user to set ProfileID

type GetProfileIdentityOptions added in v0.40.0 

type GetProfileIdentityOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

	// Type of the identity.
	IdentityType *string `json:"identity-type" validate:"required,ne="`

	// Identifier of the identity that can assume the trusted profiles.
	IdentifierID *string `json:"identifier-id" validate:"required,ne="`

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

GetProfileIdentityOptions : The GetProfileIdentity options.

func (*GetProfileIdentityOptions) SetHeaders added in v0.40.0 

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

SetHeaders : Allow user to set Headers

func (*GetProfileIdentityOptions) SetIdentifierID added in v0.40.0 

func (_options *GetProfileIdentityOptions) SetIdentifierID(identifierID string) *GetProfileIdentityOptions

SetIdentifierID : Allow user to set IdentifierID

func (*GetProfileIdentityOptions) SetIdentityType added in v0.40.0 

func (_options *GetProfileIdentityOptions) SetIdentityType(identityType string) *GetProfileIdentityOptions

SetIdentityType : Allow user to set IdentityType

func (*GetProfileIdentityOptions) SetProfileID added in v0.40.0 

func (_options *GetProfileIdentityOptions) SetProfileID(profileID string) *GetProfileIdentityOptions

SetProfileID : Allow user to set ProfileID

type GetProfileOptions added in v0.20.0 

type GetProfileOptions struct {
	// ID of the trusted profile to get.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

	// Defines if the entity's activity is included in the response. Retrieving activity data is an expensive operation, so
	// only request this when needed.
	IncludeActivity *bool `json:"include_activity,omitempty"`

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

GetProfileOptions : The GetProfile options.

func (*GetProfileOptions) SetHeaders added in v0.20.0 

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

SetHeaders : Allow user to set Headers

func (*GetProfileOptions) SetIncludeActivity added in v0.24.0 

func (_options *GetProfileOptions) SetIncludeActivity(includeActivity bool) *GetProfileOptions

SetIncludeActivity : Allow user to set IncludeActivity

func (*GetProfileOptions) SetProfileID added in v0.20.0 

func (_options *GetProfileOptions) SetProfileID(profileID string) *GetProfileOptions

SetProfileID : Allow user to set ProfileID

type GetProfileTemplateVersionOptions added in v0.42.0 

type GetProfileTemplateVersionOptions struct {
	// ID of the trusted profile template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// Version of the Profile Template.
	Version *string `json:"version" validate:"required,ne="`

	// Defines if the entity history is included in the response.
	IncludeHistory *bool `json:"include_history,omitempty"`

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

GetProfileTemplateVersionOptions : The GetProfileTemplateVersion options.

func (*GetProfileTemplateVersionOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*GetProfileTemplateVersionOptions) SetIncludeHistory added in v0.42.0 

func (_options *GetProfileTemplateVersionOptions) SetIncludeHistory(includeHistory bool) *GetProfileTemplateVersionOptions

SetIncludeHistory : Allow user to set IncludeHistory

func (*GetProfileTemplateVersionOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

func (*GetProfileTemplateVersionOptions) SetVersion added in v0.42.0 

func (_options *GetProfileTemplateVersionOptions) SetVersion(version string) *GetProfileTemplateVersionOptions

SetVersion : Allow user to set Version

type GetReportOptions added in v0.24.0 

type GetReportOptions struct {
	// ID of the account.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// Reference for the report to be generated, You can use 'latest' to get the latest report for the given account.
	Reference *string `json:"reference" validate:"required,ne="`

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

GetReportOptions : The GetReport options.

func (*GetReportOptions) SetAccountID added in v0.24.0 

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

SetAccountID : Allow user to set AccountID

func (*GetReportOptions) SetHeaders added in v0.24.0 

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

SetHeaders : Allow user to set Headers

func (*GetReportOptions) SetReference added in v0.24.0 

func (_options *GetReportOptions) SetReference(reference string) *GetReportOptions

SetReference : Allow user to set Reference

type GetServiceIDOptions added in v0.17.2 

type GetServiceIDOptions struct {
	// Unique ID of the service ID.
	ID *string `json:"id" validate:"required,ne="`

	// Defines if the entity history is included in the response.
	IncludeHistory *bool `json:"include_history,omitempty"`

	// Defines if the entity's activity is included in the response. Retrieving activity data is an expensive operation, so
	// only request this when needed.
	IncludeActivity *bool `json:"include_activity,omitempty"`

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

GetServiceIDOptions : The GetServiceID options.

func (*GetServiceIDOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*GetServiceIDOptions) SetID added in v0.17.2 

func (_options *GetServiceIDOptions) SetID(id string) *GetServiceIDOptions

SetID : Allow user to set ID

func (*GetServiceIDOptions) SetIncludeActivity added in v0.24.0 

func (_options *GetServiceIDOptions) SetIncludeActivity(includeActivity bool) *GetServiceIDOptions

SetIncludeActivity : Allow user to set IncludeActivity

func (*GetServiceIDOptions) SetIncludeHistory added in v0.17.2 

func (_options *GetServiceIDOptions) SetIncludeHistory(includeHistory bool) *GetServiceIDOptions

SetIncludeHistory : Allow user to set IncludeHistory

type GetTrustedProfileAssignmentOptions added in v0.42.0 

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

	// Defines if the entity history is included in the response.
	IncludeHistory *bool `json:"include_history,omitempty"`

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

GetTrustedProfileAssignmentOptions : The GetTrustedProfileAssignment options.

func (*GetTrustedProfileAssignmentOptions) SetAssignmentID added in v0.42.0 

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

SetAssignmentID : Allow user to set AssignmentID

func (*GetTrustedProfileAssignmentOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*GetTrustedProfileAssignmentOptions) SetIncludeHistory added in v0.42.0 

func (_options *GetTrustedProfileAssignmentOptions) SetIncludeHistory(includeHistory bool) *GetTrustedProfileAssignmentOptions

SetIncludeHistory : Allow user to set IncludeHistory

type IDBasedMfaEnrollment added in v0.31.6 

type IDBasedMfaEnrollment struct {
	// Defines the MFA trait for the account. Valid values:
	//   * NONE - No MFA trait set
	//   * NONE_NO_ROPC- No MFA, disable CLI logins with only a password
	//   * TOTP - For all non-federated IBMId users
	//   * TOTP4ALL - For all users
	//   * LEVEL1 - Email-based MFA for all users
	//   * LEVEL2 - TOTP-based MFA for all users
	//   * LEVEL3 - U2F MFA for all users.
	TraitAccountDefault *string `json:"trait_account_default" validate:"required"`

	// Defines the MFA trait for the account. Valid values:
	//   * NONE - No MFA trait set
	//   * NONE_NO_ROPC- No MFA, disable CLI logins with only a password
	//   * TOTP - For all non-federated IBMId users
	//   * TOTP4ALL - For all users
	//   * LEVEL1 - Email-based MFA for all users
	//   * LEVEL2 - TOTP-based MFA for all users
	//   * LEVEL3 - U2F MFA for all users.
	TraitUserSpecific *string `json:"trait_user_specific,omitempty"`

	// Defines the MFA trait for the account. Valid values:
	//   * NONE - No MFA trait set
	//   * NONE_NO_ROPC- No MFA, disable CLI logins with only a password
	//   * TOTP - For all non-federated IBMId users
	//   * TOTP4ALL - For all users
	//   * LEVEL1 - Email-based MFA for all users
	//   * LEVEL2 - TOTP-based MFA for all users
	//   * LEVEL3 - U2F MFA for all users.
	TraitEffective *string `json:"trait_effective" validate:"required"`

	// The enrollment complies to the effective requirement.
	Complies *bool `json:"complies" validate:"required"`

	// Defines comply state for the account. Valid values:
	//   * NO - User does not comply in the given account.
	//   * ACCOUNT- User complies in the given account, but does not comply in at least one of the other account
	// memberships.
	//   * CROSS_ACCOUNT - User complies in the given account and across all other account memberships.
	ComplyState *string `json:"comply_state,omitempty"`
}

IDBasedMfaEnrollment : IDBasedMfaEnrollment struct

type IamIdentityV1 

type IamIdentityV1 struct {
	Service *core.BaseService
}

IamIdentityV1 : The IAM Identity Service API allows for the management of Account Settings and Identities (Service IDs, ApiKeys).

API Version: 1.0.0

func NewIamIdentityV1 

func NewIamIdentityV1(options *IamIdentityV1Options) (service *IamIdentityV1, err error)

NewIamIdentityV1 : constructs an instance of IamIdentityV1 with passed in options.

func NewIamIdentityV1UsingExternalConfig 

func NewIamIdentityV1UsingExternalConfig(options *IamIdentityV1Options) (iamIdentity *IamIdentityV1, err error)

NewIamIdentityV1UsingExternalConfig : constructs an instance of IamIdentityV1 with passed in options and external configuration.

func (*IamIdentityV1) Clone added in v0.17.2 

func (iamIdentity *IamIdentityV1) Clone() *IamIdentityV1

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

func (*IamIdentityV1) CommitAccountSettingsTemplate added in v0.42.0 

func (iamIdentity *IamIdentityV1) CommitAccountSettingsTemplate(commitAccountSettingsTemplateOptions *CommitAccountSettingsTemplateOptions) (response *core.DetailedResponse, err error)

CommitAccountSettingsTemplate : Commit a template version Commit a specific version of an account settings template in an Enterprise Account. A Template must be committed before being assigned, and once committed, can no longer be modified.

func (*IamIdentityV1) CommitAccountSettingsTemplateWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) CommitAccountSettingsTemplateWithContext(ctx context.Context, commitAccountSettingsTemplateOptions *CommitAccountSettingsTemplateOptions) (response *core.DetailedResponse, err error)

CommitAccountSettingsTemplateWithContext is an alternate form of the CommitAccountSettingsTemplate method which supports a Context parameter

func (*IamIdentityV1) CommitProfileTemplate added in v0.42.0 

func (iamIdentity *IamIdentityV1) CommitProfileTemplate(commitProfileTemplateOptions *CommitProfileTemplateOptions) (response *core.DetailedResponse, err error)

CommitProfileTemplate : Commit a template version Commit a specific version of a trusted profile template in an enterprise account. You must commit a template before you can assign it to child accounts. Once a template is committed, you can no longer modify the template.

func (*IamIdentityV1) CommitProfileTemplateWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) CommitProfileTemplateWithContext(ctx context.Context, commitProfileTemplateOptions *CommitProfileTemplateOptions) (response *core.DetailedResponse, err error)

CommitProfileTemplateWithContext is an alternate form of the CommitProfileTemplate method which supports a Context parameter

func (*IamIdentityV1) CreateAPIKey added in v0.17.2 

func (iamIdentity *IamIdentityV1) CreateAPIKey(createAPIKeyOptions *CreateAPIKeyOptions) (result *APIKey, response *core.DetailedResponse, err error)

CreateAPIKey : Create an API key Creates an API key for a UserID or service ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.

func (*IamIdentityV1) CreateAPIKeyWithContext added in v0.17.2 

func (iamIdentity *IamIdentityV1) CreateAPIKeyWithContext(ctx context.Context, createAPIKeyOptions *CreateAPIKeyOptions) (result *APIKey, response *core.DetailedResponse, err error)

CreateAPIKeyWithContext is an alternate form of the CreateAPIKey method which supports a Context parameter

func (*IamIdentityV1) CreateAccountSettingsAssignment added in v0.42.0 

func (iamIdentity *IamIdentityV1) CreateAccountSettingsAssignment(createAccountSettingsAssignmentOptions *CreateAccountSettingsAssignmentOptions) (result *TemplateAssignmentResponse, response *core.DetailedResponse, err error)

CreateAccountSettingsAssignment : Create assignment Create an assigment for an account settings template.

func (*IamIdentityV1) CreateAccountSettingsAssignmentWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) CreateAccountSettingsAssignmentWithContext(ctx context.Context, createAccountSettingsAssignmentOptions *CreateAccountSettingsAssignmentOptions) (result *TemplateAssignmentResponse, response *core.DetailedResponse, err error)

CreateAccountSettingsAssignmentWithContext is an alternate form of the CreateAccountSettingsAssignment method which supports a Context parameter

func (*IamIdentityV1) CreateAccountSettingsTemplate added in v0.42.0 

func (iamIdentity *IamIdentityV1) CreateAccountSettingsTemplate(createAccountSettingsTemplateOptions *CreateAccountSettingsTemplateOptions) (result *AccountSettingsTemplateResponse, response *core.DetailedResponse, err error)

CreateAccountSettingsTemplate : Create an account settings template Create a new account settings template in an enterprise account.

func (*IamIdentityV1) CreateAccountSettingsTemplateVersion added in v0.42.0 

func (iamIdentity *IamIdentityV1) CreateAccountSettingsTemplateVersion(createAccountSettingsTemplateVersionOptions *CreateAccountSettingsTemplateVersionOptions) (result *AccountSettingsTemplateResponse, response *core.DetailedResponse, err error)

CreateAccountSettingsTemplateVersion : Create a new version of an account settings template Create a new version of an account settings template in an Enterprise Account.

func (*IamIdentityV1) CreateAccountSettingsTemplateVersionWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) CreateAccountSettingsTemplateVersionWithContext(ctx context.Context, createAccountSettingsTemplateVersionOptions *CreateAccountSettingsTemplateVersionOptions) (result *AccountSettingsTemplateResponse, response *core.DetailedResponse, err error)

CreateAccountSettingsTemplateVersionWithContext is an alternate form of the CreateAccountSettingsTemplateVersion method which supports a Context parameter

func (*IamIdentityV1) CreateAccountSettingsTemplateWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) CreateAccountSettingsTemplateWithContext(ctx context.Context, createAccountSettingsTemplateOptions *CreateAccountSettingsTemplateOptions) (result *AccountSettingsTemplateResponse, response *core.DetailedResponse, err error)

CreateAccountSettingsTemplateWithContext is an alternate form of the CreateAccountSettingsTemplate method which supports a Context parameter

func (*IamIdentityV1) CreateClaimRule added in v0.20.0 

func (iamIdentity *IamIdentityV1) CreateClaimRule(createClaimRuleOptions *CreateClaimRuleOptions) (result *ProfileClaimRule, response *core.DetailedResponse, err error)

CreateClaimRule : Create claim rule for a trusted profile Create a claim rule for a trusted profile. There is a limit of 20 rules per trusted profile.

func (*IamIdentityV1) CreateClaimRuleWithContext added in v0.20.0 

func (iamIdentity *IamIdentityV1) CreateClaimRuleWithContext(ctx context.Context, createClaimRuleOptions *CreateClaimRuleOptions) (result *ProfileClaimRule, response *core.DetailedResponse, err error)

CreateClaimRuleWithContext is an alternate form of the CreateClaimRule method which supports a Context parameter 

func (iamIdentity *IamIdentityV1) CreateLink(createLinkOptions *CreateLinkOptions) (result *ProfileLink, response *core.DetailedResponse, err error)

CreateLink : Create link to a trusted profile Create a direct link between a specific compute resource and a trusted profile, rather than creating conditions that a compute resource must fulfill to apply a trusted profile.

func (*IamIdentityV1) CreateLinkWithContext added in v0.20.0 

func (iamIdentity *IamIdentityV1) CreateLinkWithContext(ctx context.Context, createLinkOptions *CreateLinkOptions) (result *ProfileLink, response *core.DetailedResponse, err error)

CreateLinkWithContext is an alternate form of the CreateLink method which supports a Context parameter

func (*IamIdentityV1) CreateMfaReport added in v0.31.6 

func (iamIdentity *IamIdentityV1) CreateMfaReport(createMfaReportOptions *CreateMfaReportOptions) (result *ReportReference, response *core.DetailedResponse, err error)

CreateMfaReport : Trigger MFA enrollment status report for the account Trigger MFA enrollment status report for the account by specifying the account ID. It can take a few minutes to generate the report for retrieval.

func (*IamIdentityV1) CreateMfaReportWithContext added in v0.31.6 

func (iamIdentity *IamIdentityV1) CreateMfaReportWithContext(ctx context.Context, createMfaReportOptions *CreateMfaReportOptions) (result *ReportReference, response *core.DetailedResponse, err error)

CreateMfaReportWithContext is an alternate form of the CreateMfaReport method which supports a Context parameter

func (*IamIdentityV1) CreateProfile added in v0.20.0 

func (iamIdentity *IamIdentityV1) CreateProfile(createProfileOptions *CreateProfileOptions) (result *TrustedProfile, response *core.DetailedResponse, err error)

CreateProfile : Create a trusted profile Create a trusted profile for a given account ID.

func (*IamIdentityV1) CreateProfileTemplate added in v0.42.0 

func (iamIdentity *IamIdentityV1) CreateProfileTemplate(createProfileTemplateOptions *CreateProfileTemplateOptions) (result *TrustedProfileTemplateResponse, response *core.DetailedResponse, err error)

CreateProfileTemplate : Create a trusted profile template Create a new trusted profile template in an enterprise account.

func (*IamIdentityV1) CreateProfileTemplateVersion added in v0.42.0 

func (iamIdentity *IamIdentityV1) CreateProfileTemplateVersion(createProfileTemplateVersionOptions *CreateProfileTemplateVersionOptions) (result *TrustedProfileTemplateResponse, response *core.DetailedResponse, err error)

CreateProfileTemplateVersion : Create new version of a trusted profile template Create a new version of a trusted profile template in an enterprise account.

func (*IamIdentityV1) CreateProfileTemplateVersionWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) CreateProfileTemplateVersionWithContext(ctx context.Context, createProfileTemplateVersionOptions *CreateProfileTemplateVersionOptions) (result *TrustedProfileTemplateResponse, response *core.DetailedResponse, err error)

CreateProfileTemplateVersionWithContext is an alternate form of the CreateProfileTemplateVersion method which supports a Context parameter

func (*IamIdentityV1) CreateProfileTemplateWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) CreateProfileTemplateWithContext(ctx context.Context, createProfileTemplateOptions *CreateProfileTemplateOptions) (result *TrustedProfileTemplateResponse, response *core.DetailedResponse, err error)

CreateProfileTemplateWithContext is an alternate form of the CreateProfileTemplate method which supports a Context parameter

func (*IamIdentityV1) CreateProfileWithContext added in v0.20.0 

func (iamIdentity *IamIdentityV1) CreateProfileWithContext(ctx context.Context, createProfileOptions *CreateProfileOptions) (result *TrustedProfile, response *core.DetailedResponse, err error)

CreateProfileWithContext is an alternate form of the CreateProfile method which supports a Context parameter

func (*IamIdentityV1) CreateReport added in v0.24.0 

func (iamIdentity *IamIdentityV1) CreateReport(createReportOptions *CreateReportOptions) (result *ReportReference, response *core.DetailedResponse, err error)

CreateReport : Trigger activity report for the account Trigger activity report for the account by specifying the account ID. It can take a few minutes to generate the report for retrieval.

func (*IamIdentityV1) CreateReportWithContext added in v0.24.0 

func (iamIdentity *IamIdentityV1) CreateReportWithContext(ctx context.Context, createReportOptions *CreateReportOptions) (result *ReportReference, response *core.DetailedResponse, err error)

CreateReportWithContext is an alternate form of the CreateReport method which supports a Context parameter

func (*IamIdentityV1) CreateServiceID 

func (iamIdentity *IamIdentityV1) CreateServiceID(createServiceIDOptions *CreateServiceIDOptions) (result *ServiceID, response *core.DetailedResponse, err error)

CreateServiceID : Create a service ID Creates a service ID for an IBM Cloud account. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.

func (*IamIdentityV1) CreateServiceIDWithContext added in v0.12.1 

func (iamIdentity *IamIdentityV1) CreateServiceIDWithContext(ctx context.Context, createServiceIDOptions *CreateServiceIDOptions) (result *ServiceID, response *core.DetailedResponse, err error)

CreateServiceIDWithContext is an alternate form of the CreateServiceID method which supports a Context parameter

func (*IamIdentityV1) CreateTrustedProfileAssignment added in v0.42.0 

func (iamIdentity *IamIdentityV1) CreateTrustedProfileAssignment(createTrustedProfileAssignmentOptions *CreateTrustedProfileAssignmentOptions) (result *TemplateAssignmentResponse, response *core.DetailedResponse, err error)

CreateTrustedProfileAssignment : Create assignment Create an assigment for a trusted profile template.

func (*IamIdentityV1) CreateTrustedProfileAssignmentWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) CreateTrustedProfileAssignmentWithContext(ctx context.Context, createTrustedProfileAssignmentOptions *CreateTrustedProfileAssignmentOptions) (result *TemplateAssignmentResponse, response *core.DetailedResponse, err error)

CreateTrustedProfileAssignmentWithContext is an alternate form of the CreateTrustedProfileAssignment method which supports a Context parameter

func (*IamIdentityV1) DeleteAPIKey added in v0.17.2 

func (iamIdentity *IamIdentityV1) DeleteAPIKey(deleteAPIKeyOptions *DeleteAPIKeyOptions) (response *core.DetailedResponse, err error)

DeleteAPIKey : Deletes an API key Deletes an API key. Existing tokens will remain valid until expired. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.

func (*IamIdentityV1) DeleteAPIKeyWithContext added in v0.17.2 

func (iamIdentity *IamIdentityV1) DeleteAPIKeyWithContext(ctx context.Context, deleteAPIKeyOptions *DeleteAPIKeyOptions) (response *core.DetailedResponse, err error)

DeleteAPIKeyWithContext is an alternate form of the DeleteAPIKey method which supports a Context parameter

func (*IamIdentityV1) DeleteAccountSettingsAssignment added in v0.42.0 

func (iamIdentity *IamIdentityV1) DeleteAccountSettingsAssignment(deleteAccountSettingsAssignmentOptions *DeleteAccountSettingsAssignmentOptions) (result *ExceptionResponse, response *core.DetailedResponse, err error)

DeleteAccountSettingsAssignment : Delete assignment Delete an account settings template assignment. This removes any IAM resources created by this assignment in child accounts.

func (*IamIdentityV1) DeleteAccountSettingsAssignmentWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) DeleteAccountSettingsAssignmentWithContext(ctx context.Context, deleteAccountSettingsAssignmentOptions *DeleteAccountSettingsAssignmentOptions) (result *ExceptionResponse, response *core.DetailedResponse, err error)

DeleteAccountSettingsAssignmentWithContext is an alternate form of the DeleteAccountSettingsAssignment method which supports a Context parameter

func (*IamIdentityV1) DeleteAccountSettingsTemplateVersion added in v0.42.0 

func (iamIdentity *IamIdentityV1) DeleteAccountSettingsTemplateVersion(deleteAccountSettingsTemplateVersionOptions *DeleteAccountSettingsTemplateVersionOptions) (response *core.DetailedResponse, err error)

DeleteAccountSettingsTemplateVersion : Delete version of an account settings template Delete a specific version of an account settings template in an Enterprise Account.

func (*IamIdentityV1) DeleteAccountSettingsTemplateVersionWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) DeleteAccountSettingsTemplateVersionWithContext(ctx context.Context, deleteAccountSettingsTemplateVersionOptions *DeleteAccountSettingsTemplateVersionOptions) (response *core.DetailedResponse, err error)

DeleteAccountSettingsTemplateVersionWithContext is an alternate form of the DeleteAccountSettingsTemplateVersion method which supports a Context parameter

func (*IamIdentityV1) DeleteAllVersionsOfAccountSettingsTemplate added in v0.42.0 

func (iamIdentity *IamIdentityV1) DeleteAllVersionsOfAccountSettingsTemplate(deleteAllVersionsOfAccountSettingsTemplateOptions *DeleteAllVersionsOfAccountSettingsTemplateOptions) (response *core.DetailedResponse, err error)

DeleteAllVersionsOfAccountSettingsTemplate : Delete all versions of an account settings template Delete all versions of an account settings template in an enterprise account. If any version is assigned to child accounts, you must first delete the assignment.

func (*IamIdentityV1) DeleteAllVersionsOfAccountSettingsTemplateWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) DeleteAllVersionsOfAccountSettingsTemplateWithContext(ctx context.Context, deleteAllVersionsOfAccountSettingsTemplateOptions *DeleteAllVersionsOfAccountSettingsTemplateOptions) (response *core.DetailedResponse, err error)

DeleteAllVersionsOfAccountSettingsTemplateWithContext is an alternate form of the DeleteAllVersionsOfAccountSettingsTemplate method which supports a Context parameter

func (*IamIdentityV1) DeleteAllVersionsOfProfileTemplate added in v0.42.0 

func (iamIdentity *IamIdentityV1) DeleteAllVersionsOfProfileTemplate(deleteAllVersionsOfProfileTemplateOptions *DeleteAllVersionsOfProfileTemplateOptions) (response *core.DetailedResponse, err error)

DeleteAllVersionsOfProfileTemplate : Delete all versions of a trusted profile template Delete all versions of a trusted profile template in an enterprise account. If any version is assigned to child accounts, you must first delete the assignment.

func (*IamIdentityV1) DeleteAllVersionsOfProfileTemplateWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) DeleteAllVersionsOfProfileTemplateWithContext(ctx context.Context, deleteAllVersionsOfProfileTemplateOptions *DeleteAllVersionsOfProfileTemplateOptions) (response *core.DetailedResponse, err error)

DeleteAllVersionsOfProfileTemplateWithContext is an alternate form of the DeleteAllVersionsOfProfileTemplate method which supports a Context parameter

func (*IamIdentityV1) DeleteClaimRule added in v0.20.0 

func (iamIdentity *IamIdentityV1) DeleteClaimRule(deleteClaimRuleOptions *DeleteClaimRuleOptions) (response *core.DetailedResponse, err error)

DeleteClaimRule : Delete a claim rule Delete a claim rule. When you delete a claim rule, federated user or compute resources are no longer required to meet the conditions of the claim rule in order to apply the trusted profile.

func (*IamIdentityV1) DeleteClaimRuleWithContext added in v0.20.0 

func (iamIdentity *IamIdentityV1) DeleteClaimRuleWithContext(ctx context.Context, deleteClaimRuleOptions *DeleteClaimRuleOptions) (response *core.DetailedResponse, err error)

DeleteClaimRuleWithContext is an alternate form of the DeleteClaimRule method which supports a Context parameter 

func (iamIdentity *IamIdentityV1) DeleteLink(deleteLinkOptions *DeleteLinkOptions) (response *core.DetailedResponse, err error)

DeleteLink : Delete link to a trusted profile Delete a link between a compute resource and a trusted profile.

func (*IamIdentityV1) DeleteLinkWithContext added in v0.20.0 

func (iamIdentity *IamIdentityV1) DeleteLinkWithContext(ctx context.Context, deleteLinkOptions *DeleteLinkOptions) (response *core.DetailedResponse, err error)

DeleteLinkWithContext is an alternate form of the DeleteLink method which supports a Context parameter

func (*IamIdentityV1) DeleteProfile added in v0.20.0 

func (iamIdentity *IamIdentityV1) DeleteProfile(deleteProfileOptions *DeleteProfileOptions) (response *core.DetailedResponse, err error)

DeleteProfile : Delete a trusted profile Delete a trusted profile. When you delete trusted profile, compute resources and federated users are unlinked from the profile and can no longer apply the trusted profile identity.

func (*IamIdentityV1) DeleteProfileIdentity added in v0.40.0 

func (iamIdentity *IamIdentityV1) DeleteProfileIdentity(deleteProfileIdentityOptions *DeleteProfileIdentityOptions) (response *core.DetailedResponse, err error)

DeleteProfileIdentity : Delete the identity that can assume the trusted profile Delete the identity that can assume the trusted profile.

func (*IamIdentityV1) DeleteProfileIdentityWithContext added in v0.40.0 

func (iamIdentity *IamIdentityV1) DeleteProfileIdentityWithContext(ctx context.Context, deleteProfileIdentityOptions *DeleteProfileIdentityOptions) (response *core.DetailedResponse, err error)

DeleteProfileIdentityWithContext is an alternate form of the DeleteProfileIdentity method which supports a Context parameter

func (*IamIdentityV1) DeleteProfileTemplateVersion added in v0.42.0 

func (iamIdentity *IamIdentityV1) DeleteProfileTemplateVersion(deleteProfileTemplateVersionOptions *DeleteProfileTemplateVersionOptions) (response *core.DetailedResponse, err error)

DeleteProfileTemplateVersion : Delete version of trusted profile template Delete a specific version of a trusted profile template in an enterprise account. If the version is assigned to child accounts, you must first delete the assignment.

func (*IamIdentityV1) DeleteProfileTemplateVersionWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) DeleteProfileTemplateVersionWithContext(ctx context.Context, deleteProfileTemplateVersionOptions *DeleteProfileTemplateVersionOptions) (response *core.DetailedResponse, err error)

DeleteProfileTemplateVersionWithContext is an alternate form of the DeleteProfileTemplateVersion method which supports a Context parameter

func (*IamIdentityV1) DeleteProfileWithContext added in v0.20.0 

func (iamIdentity *IamIdentityV1) DeleteProfileWithContext(ctx context.Context, deleteProfileOptions *DeleteProfileOptions) (response *core.DetailedResponse, err error)

DeleteProfileWithContext is an alternate form of the DeleteProfile method which supports a Context parameter

func (*IamIdentityV1) DeleteServiceID 

func (iamIdentity *IamIdentityV1) DeleteServiceID(deleteServiceIDOptions *DeleteServiceIDOptions) (response *core.DetailedResponse, err error)

DeleteServiceID : Deletes a service ID and associated API keys Deletes a service ID and all API keys associated to it. Before deleting the service ID, all associated API keys are deleted. In case a Delete Conflict (status code 409) a retry of the request may help as the service ID is only deleted if the associated API keys were successfully deleted before. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.

func (*IamIdentityV1) DeleteServiceIDWithContext added in v0.12.1 

func (iamIdentity *IamIdentityV1) DeleteServiceIDWithContext(ctx context.Context, deleteServiceIDOptions *DeleteServiceIDOptions) (response *core.DetailedResponse, err error)

DeleteServiceIDWithContext is an alternate form of the DeleteServiceID method which supports a Context parameter

func (*IamIdentityV1) DeleteTrustedProfileAssignment added in v0.42.0 

func (iamIdentity *IamIdentityV1) DeleteTrustedProfileAssignment(deleteTrustedProfileAssignmentOptions *DeleteTrustedProfileAssignmentOptions) (result *ExceptionResponse, response *core.DetailedResponse, err error)

DeleteTrustedProfileAssignment : Delete assignment Delete a trusted profile assignment. This removes any IAM resources created by this assignment in child accounts.

func (*IamIdentityV1) DeleteTrustedProfileAssignmentWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) DeleteTrustedProfileAssignmentWithContext(ctx context.Context, deleteTrustedProfileAssignmentOptions *DeleteTrustedProfileAssignmentOptions) (result *ExceptionResponse, response *core.DetailedResponse, err error)

DeleteTrustedProfileAssignmentWithContext is an alternate form of the DeleteTrustedProfileAssignment method which supports a Context parameter

func (*IamIdentityV1) DisableAPIKey added in v0.62.0 

func (iamIdentity *IamIdentityV1) DisableAPIKey(disableAPIKeyOptions *DisableAPIKeyOptions) (response *core.DetailedResponse, err error)

DisableAPIKey : disable the API key Disable an API key. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.

func (*IamIdentityV1) DisableAPIKeyWithContext added in v0.62.0 

func (iamIdentity *IamIdentityV1) DisableAPIKeyWithContext(ctx context.Context, disableAPIKeyOptions *DisableAPIKeyOptions) (response *core.DetailedResponse, err error)

DisableAPIKeyWithContext is an alternate form of the DisableAPIKey method which supports a Context parameter

func (*IamIdentityV1) DisableRetries added in v0.12.2 

func (iamIdentity *IamIdentityV1) DisableRetries()

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

func (*IamIdentityV1) EnableAPIKey added in v0.62.0 

func (iamIdentity *IamIdentityV1) EnableAPIKey(enableAPIKeyOptions *EnableAPIKeyOptions) (response *core.DetailedResponse, err error)

EnableAPIKey : Enable the API key Enable an API key. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.

func (*IamIdentityV1) EnableAPIKeyWithContext added in v0.62.0 

func (iamIdentity *IamIdentityV1) EnableAPIKeyWithContext(ctx context.Context, enableAPIKeyOptions *EnableAPIKeyOptions) (response *core.DetailedResponse, err error)

EnableAPIKeyWithContext is an alternate form of the EnableAPIKey method which supports a Context parameter

func (*IamIdentityV1) EnableRetries added in v0.12.2 

func (iamIdentity *IamIdentityV1) 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 (*IamIdentityV1) GetAPIKey added in v0.17.2 

func (iamIdentity *IamIdentityV1) GetAPIKey(getAPIKeyOptions *GetAPIKeyOptions) (result *APIKey, response *core.DetailedResponse, err error)

GetAPIKey : Get details of an API key Returns the details of an API key. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.

func (*IamIdentityV1) GetAPIKeyWithContext added in v0.17.2 

func (iamIdentity *IamIdentityV1) GetAPIKeyWithContext(ctx context.Context, getAPIKeyOptions *GetAPIKeyOptions) (result *APIKey, response *core.DetailedResponse, err error)

GetAPIKeyWithContext is an alternate form of the GetAPIKey method which supports a Context parameter

func (*IamIdentityV1) GetAPIKeysDetails added in v0.17.2 

func (iamIdentity *IamIdentityV1) GetAPIKeysDetails(getAPIKeysDetailsOptions *GetAPIKeysDetailsOptions) (result *APIKey, response *core.DetailedResponse, err error)

GetAPIKeysDetails : Get details of an API key by its value Returns the details of an API key by its value. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.

func (*IamIdentityV1) GetAPIKeysDetailsWithContext added in v0.17.2 

func (iamIdentity *IamIdentityV1) GetAPIKeysDetailsWithContext(ctx context.Context, getAPIKeysDetailsOptions *GetAPIKeysDetailsOptions) (result *APIKey, response *core.DetailedResponse, err error)

GetAPIKeysDetailsWithContext is an alternate form of the GetAPIKeysDetails method which supports a Context parameter

func (*IamIdentityV1) GetAccountSettings added in v0.17.17 

func (iamIdentity *IamIdentityV1) GetAccountSettings(getAccountSettingsOptions *GetAccountSettingsOptions) (result *AccountSettingsResponse, response *core.DetailedResponse, err error)

GetAccountSettings : Get account configurations Returns the details of an account's configuration.

func (*IamIdentityV1) GetAccountSettingsAssignment added in v0.42.0 

func (iamIdentity *IamIdentityV1) GetAccountSettingsAssignment(getAccountSettingsAssignmentOptions *GetAccountSettingsAssignmentOptions) (result *TemplateAssignmentResponse, response *core.DetailedResponse, err error)

GetAccountSettingsAssignment : Get assignment Get an assigment for an account settings template.

func (*IamIdentityV1) GetAccountSettingsAssignmentWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) GetAccountSettingsAssignmentWithContext(ctx context.Context, getAccountSettingsAssignmentOptions *GetAccountSettingsAssignmentOptions) (result *TemplateAssignmentResponse, response *core.DetailedResponse, err error)

GetAccountSettingsAssignmentWithContext is an alternate form of the GetAccountSettingsAssignment method which supports a Context parameter

func (*IamIdentityV1) GetAccountSettingsTemplateVersion added in v0.42.0 

func (iamIdentity *IamIdentityV1) GetAccountSettingsTemplateVersion(getAccountSettingsTemplateVersionOptions *GetAccountSettingsTemplateVersionOptions) (result *AccountSettingsTemplateResponse, response *core.DetailedResponse, err error)

GetAccountSettingsTemplateVersion : Get version of an account settings template Get a specific version of an account settings template in an Enterprise Account.

func (*IamIdentityV1) GetAccountSettingsTemplateVersionWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) GetAccountSettingsTemplateVersionWithContext(ctx context.Context, getAccountSettingsTemplateVersionOptions *GetAccountSettingsTemplateVersionOptions) (result *AccountSettingsTemplateResponse, response *core.DetailedResponse, err error)

GetAccountSettingsTemplateVersionWithContext is an alternate form of the GetAccountSettingsTemplateVersion method which supports a Context parameter

func (*IamIdentityV1) GetAccountSettingsWithContext added in v0.17.17 

func (iamIdentity *IamIdentityV1) GetAccountSettingsWithContext(ctx context.Context, getAccountSettingsOptions *GetAccountSettingsOptions) (result *AccountSettingsResponse, response *core.DetailedResponse, err error)

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

func (*IamIdentityV1) GetClaimRule added in v0.20.0 

func (iamIdentity *IamIdentityV1) GetClaimRule(getClaimRuleOptions *GetClaimRuleOptions) (result *ProfileClaimRule, response *core.DetailedResponse, err error)

GetClaimRule : Get a claim rule for a trusted profile A specific claim rule can be fetched for a given trusted profile ID and rule ID.

func (*IamIdentityV1) GetClaimRuleWithContext added in v0.20.0 

func (iamIdentity *IamIdentityV1) GetClaimRuleWithContext(ctx context.Context, getClaimRuleOptions *GetClaimRuleOptions) (result *ProfileClaimRule, response *core.DetailedResponse, err error)

GetClaimRuleWithContext is an alternate form of the GetClaimRule method which supports a Context parameter

func (*IamIdentityV1) GetEnableGzipCompression added in v0.12.1 

func (iamIdentity *IamIdentityV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*IamIdentityV1) GetLatestAccountSettingsTemplateVersion added in v0.42.0 

func (iamIdentity *IamIdentityV1) GetLatestAccountSettingsTemplateVersion(getLatestAccountSettingsTemplateVersionOptions *GetLatestAccountSettingsTemplateVersionOptions) (result *AccountSettingsTemplateResponse, response *core.DetailedResponse, err error)

GetLatestAccountSettingsTemplateVersion : Get latest version of an account settings template Get the latest version of a specific account settings template in an enterprise account.

func (*IamIdentityV1) GetLatestAccountSettingsTemplateVersionWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) GetLatestAccountSettingsTemplateVersionWithContext(ctx context.Context, getLatestAccountSettingsTemplateVersionOptions *GetLatestAccountSettingsTemplateVersionOptions) (result *AccountSettingsTemplateResponse, response *core.DetailedResponse, err error)

GetLatestAccountSettingsTemplateVersionWithContext is an alternate form of the GetLatestAccountSettingsTemplateVersion method which supports a Context parameter

func (*IamIdentityV1) GetLatestProfileTemplateVersion added in v0.42.0 

func (iamIdentity *IamIdentityV1) GetLatestProfileTemplateVersion(getLatestProfileTemplateVersionOptions *GetLatestProfileTemplateVersionOptions) (result *TrustedProfileTemplateResponse, response *core.DetailedResponse, err error)

GetLatestProfileTemplateVersion : Get latest version of a trusted profile template Get the latest version of a trusted profile template in an enterprise account.

func (*IamIdentityV1) GetLatestProfileTemplateVersionWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) GetLatestProfileTemplateVersionWithContext(ctx context.Context, getLatestProfileTemplateVersionOptions *GetLatestProfileTemplateVersionOptions) (result *TrustedProfileTemplateResponse, response *core.DetailedResponse, err error)

GetLatestProfileTemplateVersionWithContext is an alternate form of the GetLatestProfileTemplateVersion method which supports a Context parameter 

func (iamIdentity *IamIdentityV1) GetLink(getLinkOptions *GetLinkOptions) (result *ProfileLink, response *core.DetailedResponse, err error)

GetLink : Get link to a trusted profile Get a specific link to a trusted profile by `link_id`.

func (*IamIdentityV1) GetLinkWithContext added in v0.20.0 

func (iamIdentity *IamIdentityV1) GetLinkWithContext(ctx context.Context, getLinkOptions *GetLinkOptions) (result *ProfileLink, response *core.DetailedResponse, err error)

GetLinkWithContext is an alternate form of the GetLink method which supports a Context parameter

func (*IamIdentityV1) GetMfaReport added in v0.31.6 

func (iamIdentity *IamIdentityV1) GetMfaReport(getMfaReportOptions *GetMfaReportOptions) (result *ReportMfaEnrollmentStatus, response *core.DetailedResponse, err error)

GetMfaReport : Get MFA enrollment status report for the account Get MFA enrollment status report for the account by specifying the account ID and the reference that is generated by triggering the report. Reports older than a day are deleted when generating a new report.

func (*IamIdentityV1) GetMfaReportWithContext added in v0.31.6 

func (iamIdentity *IamIdentityV1) GetMfaReportWithContext(ctx context.Context, getMfaReportOptions *GetMfaReportOptions) (result *ReportMfaEnrollmentStatus, response *core.DetailedResponse, err error)

GetMfaReportWithContext is an alternate form of the GetMfaReport method which supports a Context parameter

func (*IamIdentityV1) GetMfaStatus added in v0.31.6 

func (iamIdentity *IamIdentityV1) GetMfaStatus(getMfaStatusOptions *GetMfaStatusOptions) (result *UserMfaEnrollments, response *core.DetailedResponse, err error)

GetMfaStatus : Get MFA enrollment status for a single user in the account Get MFA enrollment status for a single user in the account.

func (*IamIdentityV1) GetMfaStatusWithContext added in v0.31.6 

func (iamIdentity *IamIdentityV1) GetMfaStatusWithContext(ctx context.Context, getMfaStatusOptions *GetMfaStatusOptions) (result *UserMfaEnrollments, response *core.DetailedResponse, err error)

GetMfaStatusWithContext is an alternate form of the GetMfaStatus method which supports a Context parameter

func (*IamIdentityV1) GetProfile added in v0.20.0 

func (iamIdentity *IamIdentityV1) GetProfile(getProfileOptions *GetProfileOptions) (result *TrustedProfile, response *core.DetailedResponse, err error)

GetProfile : Get a trusted profile Retrieve a trusted profile by its `profile-id`. Only the trusted profile's data is returned (`name`, `description`, `iam_id`, etc.), not the federated users or compute resources that qualify to apply the trusted profile.

func (*IamIdentityV1) GetProfileIdentities added in v0.40.0 

func (iamIdentity *IamIdentityV1) GetProfileIdentities(getProfileIdentitiesOptions *GetProfileIdentitiesOptions) (result *ProfileIdentitiesResponse, response *core.DetailedResponse, err error)

GetProfileIdentities : Get a list of identities that can assume the trusted profile Get a list of identities that can assume the trusted profile.

func (*IamIdentityV1) GetProfileIdentitiesWithContext added in v0.40.0 

func (iamIdentity *IamIdentityV1) GetProfileIdentitiesWithContext(ctx context.Context, getProfileIdentitiesOptions *GetProfileIdentitiesOptions) (result *ProfileIdentitiesResponse, response *core.DetailedResponse, err error)

GetProfileIdentitiesWithContext is an alternate form of the GetProfileIdentities method which supports a Context parameter

func (*IamIdentityV1) GetProfileIdentity added in v0.40.0 

func (iamIdentity *IamIdentityV1) GetProfileIdentity(getProfileIdentityOptions *GetProfileIdentityOptions) (result *ProfileIdentityResponse, response *core.DetailedResponse, err error)

GetProfileIdentity : Get the identity that can assume the trusted profile Get the identity that can assume the trusted profile.

func (*IamIdentityV1) GetProfileIdentityWithContext added in v0.40.0 

func (iamIdentity *IamIdentityV1) GetProfileIdentityWithContext(ctx context.Context, getProfileIdentityOptions *GetProfileIdentityOptions) (result *ProfileIdentityResponse, response *core.DetailedResponse, err error)

GetProfileIdentityWithContext is an alternate form of the GetProfileIdentity method which supports a Context parameter

func (*IamIdentityV1) GetProfileTemplateVersion added in v0.42.0 

func (iamIdentity *IamIdentityV1) GetProfileTemplateVersion(getProfileTemplateVersionOptions *GetProfileTemplateVersionOptions) (result *TrustedProfileTemplateResponse, response *core.DetailedResponse, err error)

GetProfileTemplateVersion : Get version of trusted profile template Get a specific version of a trusted profile template in an enterprise account.

func (*IamIdentityV1) GetProfileTemplateVersionWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) GetProfileTemplateVersionWithContext(ctx context.Context, getProfileTemplateVersionOptions *GetProfileTemplateVersionOptions) (result *TrustedProfileTemplateResponse, response *core.DetailedResponse, err error)

GetProfileTemplateVersionWithContext is an alternate form of the GetProfileTemplateVersion method which supports a Context parameter

func (*IamIdentityV1) GetProfileWithContext added in v0.20.0 

func (iamIdentity *IamIdentityV1) GetProfileWithContext(ctx context.Context, getProfileOptions *GetProfileOptions) (result *TrustedProfile, response *core.DetailedResponse, err error)

GetProfileWithContext is an alternate form of the GetProfile method which supports a Context parameter

func (*IamIdentityV1) GetReport added in v0.24.0 

func (iamIdentity *IamIdentityV1) GetReport(getReportOptions *GetReportOptions) (result *Report, response *core.DetailedResponse, err error)

GetReport : Get activity report for the account Get activity report for the account by specifying the account ID and the reference that is generated by triggering the report. Reports older than a day are deleted when generating a new report.

func (*IamIdentityV1) GetReportWithContext added in v0.24.0 

func (iamIdentity *IamIdentityV1) GetReportWithContext(ctx context.Context, getReportOptions *GetReportOptions) (result *Report, response *core.DetailedResponse, err error)

GetReportWithContext is an alternate form of the GetReport method which supports a Context parameter

func (*IamIdentityV1) GetServiceID 

func (iamIdentity *IamIdentityV1) GetServiceID(getServiceIDOptions *GetServiceIDOptions) (result *ServiceID, response *core.DetailedResponse, err error)

GetServiceID : Get details of a service ID Returns the details of a service ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. Note: apikey details are only included in the response when creating a Service ID with an api key.

func (*IamIdentityV1) GetServiceIDWithContext added in v0.12.1 

func (iamIdentity *IamIdentityV1) GetServiceIDWithContext(ctx context.Context, getServiceIDOptions *GetServiceIDOptions) (result *ServiceID, response *core.DetailedResponse, err error)

GetServiceIDWithContext is an alternate form of the GetServiceID method which supports a Context parameter

func (*IamIdentityV1) GetServiceURL added in v0.12.1 

func (iamIdentity *IamIdentityV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*IamIdentityV1) GetTrustedProfileAssignment added in v0.42.0 

func (iamIdentity *IamIdentityV1) GetTrustedProfileAssignment(getTrustedProfileAssignmentOptions *GetTrustedProfileAssignmentOptions) (result *TemplateAssignmentResponse, response *core.DetailedResponse, err error)

GetTrustedProfileAssignment : Get assignment Get an assigment for a trusted profile template.

func (*IamIdentityV1) GetTrustedProfileAssignmentWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) GetTrustedProfileAssignmentWithContext(ctx context.Context, getTrustedProfileAssignmentOptions *GetTrustedProfileAssignmentOptions) (result *TemplateAssignmentResponse, response *core.DetailedResponse, err error)

GetTrustedProfileAssignmentWithContext is an alternate form of the GetTrustedProfileAssignment method which supports a Context parameter

func (*IamIdentityV1) ListAPIKeys added in v0.17.2 

func (iamIdentity *IamIdentityV1) ListAPIKeys(listAPIKeysOptions *ListAPIKeysOptions) (result *APIKeyList, response *core.DetailedResponse, err error)

ListAPIKeys : Get API keys for a given service or user IAM ID and account ID Returns the list of API key details for a given service or user IAM ID and account ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.

func (*IamIdentityV1) ListAPIKeysWithContext added in v0.17.2 

func (iamIdentity *IamIdentityV1) ListAPIKeysWithContext(ctx context.Context, listAPIKeysOptions *ListAPIKeysOptions) (result *APIKeyList, response *core.DetailedResponse, err error)

ListAPIKeysWithContext is an alternate form of the ListAPIKeys method which supports a Context parameter

func (*IamIdentityV1) ListAccountSettingsAssignments added in v0.42.0 

func (iamIdentity *IamIdentityV1) ListAccountSettingsAssignments(listAccountSettingsAssignmentsOptions *ListAccountSettingsAssignmentsOptions) (result *TemplateAssignmentListResponse, response *core.DetailedResponse, err error)

ListAccountSettingsAssignments : List assignments List account settings assignments.

func (*IamIdentityV1) ListAccountSettingsAssignmentsWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) ListAccountSettingsAssignmentsWithContext(ctx context.Context, listAccountSettingsAssignmentsOptions *ListAccountSettingsAssignmentsOptions) (result *TemplateAssignmentListResponse, response *core.DetailedResponse, err error)

ListAccountSettingsAssignmentsWithContext is an alternate form of the ListAccountSettingsAssignments method which supports a Context parameter

func (*IamIdentityV1) ListAccountSettingsTemplates added in v0.42.0 

func (iamIdentity *IamIdentityV1) ListAccountSettingsTemplates(listAccountSettingsTemplatesOptions *ListAccountSettingsTemplatesOptions) (result *AccountSettingsTemplateList, response *core.DetailedResponse, err error)

ListAccountSettingsTemplates : List account settings templates List account settings templates in an enterprise account.

func (*IamIdentityV1) ListAccountSettingsTemplatesWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) ListAccountSettingsTemplatesWithContext(ctx context.Context, listAccountSettingsTemplatesOptions *ListAccountSettingsTemplatesOptions) (result *AccountSettingsTemplateList, response *core.DetailedResponse, err error)

ListAccountSettingsTemplatesWithContext is an alternate form of the ListAccountSettingsTemplates method which supports a Context parameter

func (*IamIdentityV1) ListClaimRules added in v0.20.0 

func (iamIdentity *IamIdentityV1) ListClaimRules(listClaimRulesOptions *ListClaimRulesOptions) (result *ProfileClaimRuleList, response *core.DetailedResponse, err error)

ListClaimRules : List claim rules for a trusted profile Get a list of all claim rules for a trusted profile. The `profile-id` query parameter determines the profile from which to retrieve the list of claim rules.

func (*IamIdentityV1) ListClaimRulesWithContext added in v0.20.0 

func (iamIdentity *IamIdentityV1) ListClaimRulesWithContext(ctx context.Context, listClaimRulesOptions *ListClaimRulesOptions) (result *ProfileClaimRuleList, response *core.DetailedResponse, err error)

ListClaimRulesWithContext is an alternate form of the ListClaimRules method which supports a Context parameter 

func (iamIdentity *IamIdentityV1) ListLinks(listLinksOptions *ListLinksOptions) (result *ProfileLinkList, response *core.DetailedResponse, err error)

ListLinks : List links to a trusted profile Get a list of links to a trusted profile.

func (*IamIdentityV1) ListLinksWithContext added in v0.20.1 

func (iamIdentity *IamIdentityV1) ListLinksWithContext(ctx context.Context, listLinksOptions *ListLinksOptions) (result *ProfileLinkList, response *core.DetailedResponse, err error)

ListLinksWithContext is an alternate form of the ListLinks method which supports a Context parameter

func (*IamIdentityV1) ListProfileTemplates added in v0.42.0 

func (iamIdentity *IamIdentityV1) ListProfileTemplates(listProfileTemplatesOptions *ListProfileTemplatesOptions) (result *TrustedProfileTemplateList, response *core.DetailedResponse, err error)

ListProfileTemplates : List trusted profile templates List the trusted profile templates in an enterprise account.

func (*IamIdentityV1) ListProfileTemplatesWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) ListProfileTemplatesWithContext(ctx context.Context, listProfileTemplatesOptions *ListProfileTemplatesOptions) (result *TrustedProfileTemplateList, response *core.DetailedResponse, err error)

ListProfileTemplatesWithContext is an alternate form of the ListProfileTemplates method which supports a Context parameter

func (*IamIdentityV1) ListProfiles added in v0.20.1 

func (iamIdentity *IamIdentityV1) ListProfiles(listProfilesOptions *ListProfilesOptions) (result *TrustedProfilesList, response *core.DetailedResponse, err error)

ListProfiles : List trusted profiles List the trusted profiles in an account. The `account_id` query parameter determines the account from which to retrieve the list of trusted profiles.

func (*IamIdentityV1) ListProfilesWithContext added in v0.20.1 

func (iamIdentity *IamIdentityV1) ListProfilesWithContext(ctx context.Context, listProfilesOptions *ListProfilesOptions) (result *TrustedProfilesList, response *core.DetailedResponse, err error)

ListProfilesWithContext is an alternate form of the ListProfiles method which supports a Context parameter

func (*IamIdentityV1) ListServiceIds 

func (iamIdentity *IamIdentityV1) ListServiceIds(listServiceIdsOptions *ListServiceIdsOptions) (result *ServiceIDList, response *core.DetailedResponse, err error)

ListServiceIds : List service IDs Returns a list of service IDs. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. Note: apikey details are only included in the response when creating a Service ID with an api key.

func (*IamIdentityV1) ListServiceIdsWithContext added in v0.12.1 

func (iamIdentity *IamIdentityV1) ListServiceIdsWithContext(ctx context.Context, listServiceIdsOptions *ListServiceIdsOptions) (result *ServiceIDList, response *core.DetailedResponse, err error)

ListServiceIdsWithContext is an alternate form of the ListServiceIds method which supports a Context parameter

func (*IamIdentityV1) ListTrustedProfileAssignments added in v0.42.0 

func (iamIdentity *IamIdentityV1) ListTrustedProfileAssignments(listTrustedProfileAssignmentsOptions *ListTrustedProfileAssignmentsOptions) (result *TemplateAssignmentListResponse, response *core.DetailedResponse, err error)

ListTrustedProfileAssignments : List assignments List trusted profile template assignments.

func (*IamIdentityV1) ListTrustedProfileAssignmentsWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) ListTrustedProfileAssignmentsWithContext(ctx context.Context, listTrustedProfileAssignmentsOptions *ListTrustedProfileAssignmentsOptions) (result *TemplateAssignmentListResponse, response *core.DetailedResponse, err error)

ListTrustedProfileAssignmentsWithContext is an alternate form of the ListTrustedProfileAssignments method which supports a Context parameter

func (*IamIdentityV1) ListVersionsOfAccountSettingsTemplate added in v0.42.0 

func (iamIdentity *IamIdentityV1) ListVersionsOfAccountSettingsTemplate(listVersionsOfAccountSettingsTemplateOptions *ListVersionsOfAccountSettingsTemplateOptions) (result *AccountSettingsTemplateList, response *core.DetailedResponse, err error)

ListVersionsOfAccountSettingsTemplate : List account settings template versions List the versions of a specific account settings template in an enterprise account.

func (*IamIdentityV1) ListVersionsOfAccountSettingsTemplateWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) ListVersionsOfAccountSettingsTemplateWithContext(ctx context.Context, listVersionsOfAccountSettingsTemplateOptions *ListVersionsOfAccountSettingsTemplateOptions) (result *AccountSettingsTemplateList, response *core.DetailedResponse, err error)

ListVersionsOfAccountSettingsTemplateWithContext is an alternate form of the ListVersionsOfAccountSettingsTemplate method which supports a Context parameter

func (*IamIdentityV1) ListVersionsOfProfileTemplate added in v0.42.0 

func (iamIdentity *IamIdentityV1) ListVersionsOfProfileTemplate(listVersionsOfProfileTemplateOptions *ListVersionsOfProfileTemplateOptions) (result *TrustedProfileTemplateList, response *core.DetailedResponse, err error)

ListVersionsOfProfileTemplate : List trusted profile template versions List the versions of a trusted profile template in an enterprise account.

func (*IamIdentityV1) ListVersionsOfProfileTemplateWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) ListVersionsOfProfileTemplateWithContext(ctx context.Context, listVersionsOfProfileTemplateOptions *ListVersionsOfProfileTemplateOptions) (result *TrustedProfileTemplateList, response *core.DetailedResponse, err error)

ListVersionsOfProfileTemplateWithContext is an alternate form of the ListVersionsOfProfileTemplate method which supports a Context parameter

func (*IamIdentityV1) LockAPIKey added in v0.17.2 

func (iamIdentity *IamIdentityV1) LockAPIKey(lockAPIKeyOptions *LockAPIKeyOptions) (response *core.DetailedResponse, err error)

LockAPIKey : Lock the API key Locks an API key by ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.

func (*IamIdentityV1) LockAPIKeyWithContext added in v0.17.2 

func (iamIdentity *IamIdentityV1) LockAPIKeyWithContext(ctx context.Context, lockAPIKeyOptions *LockAPIKeyOptions) (response *core.DetailedResponse, err error)

LockAPIKeyWithContext is an alternate form of the LockAPIKey method which supports a Context parameter

func (*IamIdentityV1) LockServiceID 

func (iamIdentity *IamIdentityV1) LockServiceID(lockServiceIDOptions *LockServiceIDOptions) (response *core.DetailedResponse, err error)

LockServiceID : Lock the service ID Locks a service ID by ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.

func (*IamIdentityV1) LockServiceIDWithContext added in v0.12.1 

func (iamIdentity *IamIdentityV1) LockServiceIDWithContext(ctx context.Context, lockServiceIDOptions *LockServiceIDOptions) (response *core.DetailedResponse, err error)

LockServiceIDWithContext is an alternate form of the LockServiceID method which supports a Context parameter

func (*IamIdentityV1) NewAPIKeyInsideCreateServiceIDRequest added in v0.17.2 

func (*IamIdentityV1) NewAPIKeyInsideCreateServiceIDRequest(name string) (_model *APIKeyInsideCreateServiceIDRequest, err error)

NewAPIKeyInsideCreateServiceIDRequest : Instantiate APIKeyInsideCreateServiceIDRequest (Generic Model Constructor)

func (*IamIdentityV1) NewAccountSettingsUserMfa added in v0.31.0 

func (*IamIdentityV1) NewAccountSettingsUserMfa(iamID string, mfa string) (_model *AccountSettingsUserMfa, err error)

NewAccountSettingsUserMfa : Instantiate AccountSettingsUserMfa (Generic Model Constructor)

func (*IamIdentityV1) NewCommitAccountSettingsTemplateOptions added in v0.42.0 

func (*IamIdentityV1) NewCommitAccountSettingsTemplateOptions(templateID string, version string) *CommitAccountSettingsTemplateOptions

NewCommitAccountSettingsTemplateOptions : Instantiate CommitAccountSettingsTemplateOptions

func (*IamIdentityV1) NewCommitProfileTemplateOptions added in v0.42.0 

func (*IamIdentityV1) NewCommitProfileTemplateOptions(templateID string, version string) *CommitProfileTemplateOptions

NewCommitProfileTemplateOptions : Instantiate CommitProfileTemplateOptions

func (*IamIdentityV1) NewCreateAPIKeyOptions added in v0.17.2 

func (*IamIdentityV1) NewCreateAPIKeyOptions(name string, iamID string) *CreateAPIKeyOptions

NewCreateAPIKeyOptions : Instantiate CreateAPIKeyOptions

func (*IamIdentityV1) NewCreateAccountSettingsAssignmentOptions added in v0.42.0 

func (*IamIdentityV1) NewCreateAccountSettingsAssignmentOptions(templateID string, templateVersion int64, targetType string, target string) *CreateAccountSettingsAssignmentOptions

NewCreateAccountSettingsAssignmentOptions : Instantiate CreateAccountSettingsAssignmentOptions

func (*IamIdentityV1) NewCreateAccountSettingsTemplateOptions added in v0.42.0 

func (*IamIdentityV1) NewCreateAccountSettingsTemplateOptions() *CreateAccountSettingsTemplateOptions

NewCreateAccountSettingsTemplateOptions : Instantiate CreateAccountSettingsTemplateOptions

func (*IamIdentityV1) NewCreateAccountSettingsTemplateVersionOptions added in v0.42.0 

func (*IamIdentityV1) NewCreateAccountSettingsTemplateVersionOptions(templateID string) *CreateAccountSettingsTemplateVersionOptions

NewCreateAccountSettingsTemplateVersionOptions : Instantiate CreateAccountSettingsTemplateVersionOptions

func (*IamIdentityV1) NewCreateClaimRuleOptions added in v0.20.0 

func (*IamIdentityV1) NewCreateClaimRuleOptions(profileID string, typeVar string, conditions []ProfileClaimRuleConditions) *CreateClaimRuleOptions

NewCreateClaimRuleOptions : Instantiate CreateClaimRuleOptions

func (*IamIdentityV1) NewCreateLinkOptions added in v0.20.0 

func (*IamIdentityV1) NewCreateLinkOptions(profileID string, crType string, link *CreateProfileLinkRequestLink) *CreateLinkOptions

NewCreateLinkOptions : Instantiate CreateLinkOptions

func (*IamIdentityV1) NewCreateMfaReportOptions added in v0.31.6 

func (*IamIdentityV1) NewCreateMfaReportOptions(accountID string) *CreateMfaReportOptions

NewCreateMfaReportOptions : Instantiate CreateMfaReportOptions 

func (*IamIdentityV1) NewCreateProfileLinkRequestLink(crn string, namespace string) (_model *CreateProfileLinkRequestLink, err error)

NewCreateProfileLinkRequestLink : Instantiate CreateProfileLinkRequestLink (Generic Model Constructor)

func (*IamIdentityV1) NewCreateProfileOptions added in v0.20.0 

func (*IamIdentityV1) NewCreateProfileOptions(name string, accountID string) *CreateProfileOptions

NewCreateProfileOptions : Instantiate CreateProfileOptions

func (*IamIdentityV1) NewCreateProfileTemplateOptions added in v0.42.0 

func (*IamIdentityV1) NewCreateProfileTemplateOptions() *CreateProfileTemplateOptions

NewCreateProfileTemplateOptions : Instantiate CreateProfileTemplateOptions

func (*IamIdentityV1) NewCreateProfileTemplateVersionOptions added in v0.42.0 

func (*IamIdentityV1) NewCreateProfileTemplateVersionOptions(templateID string) *CreateProfileTemplateVersionOptions

NewCreateProfileTemplateVersionOptions : Instantiate CreateProfileTemplateVersionOptions

func (*IamIdentityV1) NewCreateReportOptions added in v0.24.0 

func (*IamIdentityV1) NewCreateReportOptions(accountID string) *CreateReportOptions

NewCreateReportOptions : Instantiate CreateReportOptions

func (*IamIdentityV1) NewCreateServiceIDOptions added in v0.17.2 

func (*IamIdentityV1) NewCreateServiceIDOptions(accountID string, name string) *CreateServiceIDOptions

NewCreateServiceIDOptions : Instantiate CreateServiceIDOptions

func (*IamIdentityV1) NewCreateTrustedProfileAssignmentOptions added in v0.42.0 

func (*IamIdentityV1) NewCreateTrustedProfileAssignmentOptions(templateID string, templateVersion int64, targetType string, target string) *CreateTrustedProfileAssignmentOptions

NewCreateTrustedProfileAssignmentOptions : Instantiate CreateTrustedProfileAssignmentOptions

func (*IamIdentityV1) NewDeleteAPIKeyOptions added in v0.17.2 

func (*IamIdentityV1) NewDeleteAPIKeyOptions(id string) *DeleteAPIKeyOptions

NewDeleteAPIKeyOptions : Instantiate DeleteAPIKeyOptions

func (*IamIdentityV1) NewDeleteAccountSettingsAssignmentOptions added in v0.42.0 

func (*IamIdentityV1) NewDeleteAccountSettingsAssignmentOptions(assignmentID string) *DeleteAccountSettingsAssignmentOptions

NewDeleteAccountSettingsAssignmentOptions : Instantiate DeleteAccountSettingsAssignmentOptions

func (*IamIdentityV1) NewDeleteAccountSettingsTemplateVersionOptions added in v0.42.0 

func (*IamIdentityV1) NewDeleteAccountSettingsTemplateVersionOptions(templateID string, version string) *DeleteAccountSettingsTemplateVersionOptions

NewDeleteAccountSettingsTemplateVersionOptions : Instantiate DeleteAccountSettingsTemplateVersionOptions

func (*IamIdentityV1) NewDeleteAllVersionsOfAccountSettingsTemplateOptions added in v0.42.0 

func (*IamIdentityV1) NewDeleteAllVersionsOfAccountSettingsTemplateOptions(templateID string) *DeleteAllVersionsOfAccountSettingsTemplateOptions

NewDeleteAllVersionsOfAccountSettingsTemplateOptions : Instantiate DeleteAllVersionsOfAccountSettingsTemplateOptions

func (*IamIdentityV1) NewDeleteAllVersionsOfProfileTemplateOptions added in v0.42.0 

func (*IamIdentityV1) NewDeleteAllVersionsOfProfileTemplateOptions(templateID string) *DeleteAllVersionsOfProfileTemplateOptions

NewDeleteAllVersionsOfProfileTemplateOptions : Instantiate DeleteAllVersionsOfProfileTemplateOptions

func (*IamIdentityV1) NewDeleteClaimRuleOptions added in v0.20.0 

func (*IamIdentityV1) NewDeleteClaimRuleOptions(profileID string, ruleID string) *DeleteClaimRuleOptions

NewDeleteClaimRuleOptions : Instantiate DeleteClaimRuleOptions

func (*IamIdentityV1) NewDeleteLinkOptions added in v0.20.0 

func (*IamIdentityV1) NewDeleteLinkOptions(profileID string, linkID string) *DeleteLinkOptions

NewDeleteLinkOptions : Instantiate DeleteLinkOptions

func (*IamIdentityV1) NewDeleteProfileIdentityOptions added in v0.40.0 

func (*IamIdentityV1) NewDeleteProfileIdentityOptions(profileID string, identityType string, identifierID string) *DeleteProfileIdentityOptions

NewDeleteProfileIdentityOptions : Instantiate DeleteProfileIdentityOptions

func (*IamIdentityV1) NewDeleteProfileOptions added in v0.20.0 

func (*IamIdentityV1) NewDeleteProfileOptions(profileID string) *DeleteProfileOptions

NewDeleteProfileOptions : Instantiate DeleteProfileOptions

func (*IamIdentityV1) NewDeleteProfileTemplateVersionOptions added in v0.42.0 

func (*IamIdentityV1) NewDeleteProfileTemplateVersionOptions(templateID string, version string) *DeleteProfileTemplateVersionOptions

NewDeleteProfileTemplateVersionOptions : Instantiate DeleteProfileTemplateVersionOptions

func (*IamIdentityV1) NewDeleteServiceIDOptions added in v0.17.2 

func (*IamIdentityV1) NewDeleteServiceIDOptions(id string) *DeleteServiceIDOptions

NewDeleteServiceIDOptions : Instantiate DeleteServiceIDOptions

func (*IamIdentityV1) NewDeleteTrustedProfileAssignmentOptions added in v0.42.0 

func (*IamIdentityV1) NewDeleteTrustedProfileAssignmentOptions(assignmentID string) *DeleteTrustedProfileAssignmentOptions

NewDeleteTrustedProfileAssignmentOptions : Instantiate DeleteTrustedProfileAssignmentOptions

func (*IamIdentityV1) NewDisableAPIKeyOptions added in v0.62.0 

func (*IamIdentityV1) NewDisableAPIKeyOptions(id string) *DisableAPIKeyOptions

NewDisableAPIKeyOptions : Instantiate DisableAPIKeyOptions

func (*IamIdentityV1) NewEnableAPIKeyOptions added in v0.62.0 

func (*IamIdentityV1) NewEnableAPIKeyOptions(id string) *EnableAPIKeyOptions

NewEnableAPIKeyOptions : Instantiate EnableAPIKeyOptions

func (*IamIdentityV1) NewGetAPIKeyOptions added in v0.17.2 

func (*IamIdentityV1) NewGetAPIKeyOptions(id string) *GetAPIKeyOptions

NewGetAPIKeyOptions : Instantiate GetAPIKeyOptions

func (*IamIdentityV1) NewGetAPIKeysDetailsOptions added in v0.17.2 

func (*IamIdentityV1) NewGetAPIKeysDetailsOptions() *GetAPIKeysDetailsOptions

NewGetAPIKeysDetailsOptions : Instantiate GetAPIKeysDetailsOptions

func (*IamIdentityV1) NewGetAccountSettingsAssignmentOptions added in v0.42.0 

func (*IamIdentityV1) NewGetAccountSettingsAssignmentOptions(assignmentID string) *GetAccountSettingsAssignmentOptions

NewGetAccountSettingsAssignmentOptions : Instantiate GetAccountSettingsAssignmentOptions

func (*IamIdentityV1) NewGetAccountSettingsOptions added in v0.17.17 

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

NewGetAccountSettingsOptions : Instantiate GetAccountSettingsOptions

func (*IamIdentityV1) NewGetAccountSettingsTemplateVersionOptions added in v0.42.0 

func (*IamIdentityV1) NewGetAccountSettingsTemplateVersionOptions(templateID string, version string) *GetAccountSettingsTemplateVersionOptions

NewGetAccountSettingsTemplateVersionOptions : Instantiate GetAccountSettingsTemplateVersionOptions

func (*IamIdentityV1) NewGetClaimRuleOptions added in v0.20.0 

func (*IamIdentityV1) NewGetClaimRuleOptions(profileID string, ruleID string) *GetClaimRuleOptions

NewGetClaimRuleOptions : Instantiate GetClaimRuleOptions

func (*IamIdentityV1) NewGetLatestAccountSettingsTemplateVersionOptions added in v0.42.0 

func (*IamIdentityV1) NewGetLatestAccountSettingsTemplateVersionOptions(templateID string) *GetLatestAccountSettingsTemplateVersionOptions

NewGetLatestAccountSettingsTemplateVersionOptions : Instantiate GetLatestAccountSettingsTemplateVersionOptions

func (*IamIdentityV1) NewGetLatestProfileTemplateVersionOptions added in v0.42.0 

func (*IamIdentityV1) NewGetLatestProfileTemplateVersionOptions(templateID string) *GetLatestProfileTemplateVersionOptions

NewGetLatestProfileTemplateVersionOptions : Instantiate GetLatestProfileTemplateVersionOptions

func (*IamIdentityV1) NewGetLinkOptions added in v0.20.0 

func (*IamIdentityV1) NewGetLinkOptions(profileID string, linkID string) *GetLinkOptions

NewGetLinkOptions : Instantiate GetLinkOptions

func (*IamIdentityV1) NewGetMfaReportOptions added in v0.31.6 

func (*IamIdentityV1) NewGetMfaReportOptions(accountID string, reference string) *GetMfaReportOptions

NewGetMfaReportOptions : Instantiate GetMfaReportOptions

func (*IamIdentityV1) NewGetMfaStatusOptions added in v0.31.6 

func (*IamIdentityV1) NewGetMfaStatusOptions(accountID string, iamID string) *GetMfaStatusOptions

NewGetMfaStatusOptions : Instantiate GetMfaStatusOptions

func (*IamIdentityV1) NewGetProfileIdentitiesOptions added in v0.40.0 

func (*IamIdentityV1) NewGetProfileIdentitiesOptions(profileID string) *GetProfileIdentitiesOptions

NewGetProfileIdentitiesOptions : Instantiate GetProfileIdentitiesOptions

func (*IamIdentityV1) NewGetProfileIdentityOptions added in v0.40.0 

func (*IamIdentityV1) NewGetProfileIdentityOptions(profileID string, identityType string, identifierID string) *GetProfileIdentityOptions

NewGetProfileIdentityOptions : Instantiate GetProfileIdentityOptions

func (*IamIdentityV1) NewGetProfileOptions added in v0.20.0 

func (*IamIdentityV1) NewGetProfileOptions(profileID string) *GetProfileOptions

NewGetProfileOptions : Instantiate GetProfileOptions

func (*IamIdentityV1) NewGetProfileTemplateVersionOptions added in v0.42.0 

func (*IamIdentityV1) NewGetProfileTemplateVersionOptions(templateID string, version string) *GetProfileTemplateVersionOptions

NewGetProfileTemplateVersionOptions : Instantiate GetProfileTemplateVersionOptions

func (*IamIdentityV1) NewGetReportOptions added in v0.24.0 

func (*IamIdentityV1) NewGetReportOptions(accountID string, reference string) *GetReportOptions

NewGetReportOptions : Instantiate GetReportOptions

func (*IamIdentityV1) NewGetServiceIDOptions added in v0.17.2 

func (*IamIdentityV1) NewGetServiceIDOptions(id string) *GetServiceIDOptions

NewGetServiceIDOptions : Instantiate GetServiceIDOptions

func (*IamIdentityV1) NewGetTrustedProfileAssignmentOptions added in v0.42.0 

func (*IamIdentityV1) NewGetTrustedProfileAssignmentOptions(assignmentID string) *GetTrustedProfileAssignmentOptions

NewGetTrustedProfileAssignmentOptions : Instantiate GetTrustedProfileAssignmentOptions

func (*IamIdentityV1) NewListAPIKeysOptions added in v0.17.2 

func (*IamIdentityV1) NewListAPIKeysOptions() *ListAPIKeysOptions

NewListAPIKeysOptions : Instantiate ListAPIKeysOptions

func (*IamIdentityV1) NewListAccountSettingsAssignmentsOptions added in v0.42.0 

func (*IamIdentityV1) NewListAccountSettingsAssignmentsOptions() *ListAccountSettingsAssignmentsOptions

NewListAccountSettingsAssignmentsOptions : Instantiate ListAccountSettingsAssignmentsOptions

func (*IamIdentityV1) NewListAccountSettingsTemplatesOptions added in v0.42.0 

func (*IamIdentityV1) NewListAccountSettingsTemplatesOptions() *ListAccountSettingsTemplatesOptions

NewListAccountSettingsTemplatesOptions : Instantiate ListAccountSettingsTemplatesOptions

func (*IamIdentityV1) NewListClaimRulesOptions added in v0.20.0 

func (*IamIdentityV1) NewListClaimRulesOptions(profileID string) *ListClaimRulesOptions

NewListClaimRulesOptions : Instantiate ListClaimRulesOptions

func (*IamIdentityV1) NewListLinksOptions added in v0.20.1 

func (*IamIdentityV1) NewListLinksOptions(profileID string) *ListLinksOptions

NewListLinksOptions : Instantiate ListLinksOptions

func (*IamIdentityV1) NewListProfileTemplatesOptions added in v0.42.0 

func (*IamIdentityV1) NewListProfileTemplatesOptions() *ListProfileTemplatesOptions

NewListProfileTemplatesOptions : Instantiate ListProfileTemplatesOptions

func (*IamIdentityV1) NewListProfilesOptions added in v0.20.1 

func (*IamIdentityV1) NewListProfilesOptions(accountID string) *ListProfilesOptions

NewListProfilesOptions : Instantiate ListProfilesOptions

func (*IamIdentityV1) NewListServiceIdsOptions 

func (*IamIdentityV1) NewListServiceIdsOptions() *ListServiceIdsOptions

NewListServiceIdsOptions : Instantiate ListServiceIdsOptions

func (*IamIdentityV1) NewListTrustedProfileAssignmentsOptions added in v0.42.0 

func (*IamIdentityV1) NewListTrustedProfileAssignmentsOptions() *ListTrustedProfileAssignmentsOptions

NewListTrustedProfileAssignmentsOptions : Instantiate ListTrustedProfileAssignmentsOptions

func (*IamIdentityV1) NewListVersionsOfAccountSettingsTemplateOptions added in v0.42.0 

func (*IamIdentityV1) NewListVersionsOfAccountSettingsTemplateOptions(templateID string) *ListVersionsOfAccountSettingsTemplateOptions

NewListVersionsOfAccountSettingsTemplateOptions : Instantiate ListVersionsOfAccountSettingsTemplateOptions

func (*IamIdentityV1) NewListVersionsOfProfileTemplateOptions added in v0.42.0 

func (*IamIdentityV1) NewListVersionsOfProfileTemplateOptions(templateID string) *ListVersionsOfProfileTemplateOptions

NewListVersionsOfProfileTemplateOptions : Instantiate ListVersionsOfProfileTemplateOptions

func (*IamIdentityV1) NewLockAPIKeyOptions added in v0.17.2 

func (*IamIdentityV1) NewLockAPIKeyOptions(id string) *LockAPIKeyOptions

NewLockAPIKeyOptions : Instantiate LockAPIKeyOptions

func (*IamIdentityV1) NewLockServiceIDOptions added in v0.17.2 

func (*IamIdentityV1) NewLockServiceIDOptions(id string) *LockServiceIDOptions

NewLockServiceIDOptions : Instantiate LockServiceIDOptions

func (*IamIdentityV1) NewPolicyTemplateReference added in v0.42.0 

func (*IamIdentityV1) NewPolicyTemplateReference(id string, version string) (_model *PolicyTemplateReference, err error)

NewPolicyTemplateReference : Instantiate PolicyTemplateReference (Generic Model Constructor)

func (*IamIdentityV1) NewProfileClaimRuleConditions added in v0.20.0 

func (*IamIdentityV1) NewProfileClaimRuleConditions(claim string, operator string, value string) (_model *ProfileClaimRuleConditions, err error)

NewProfileClaimRuleConditions : Instantiate ProfileClaimRuleConditions (Generic Model Constructor)

func (*IamIdentityV1) NewProfileIdentityRequest added in v0.42.0 

func (*IamIdentityV1) NewProfileIdentityRequest(identifier string, typeVar string) (_model *ProfileIdentityRequest, err error)

NewProfileIdentityRequest : Instantiate ProfileIdentityRequest (Generic Model Constructor)

func (*IamIdentityV1) NewSetProfileIdentitiesOptions added in v0.40.0 

func (*IamIdentityV1) NewSetProfileIdentitiesOptions(profileID string, ifMatch string) *SetProfileIdentitiesOptions

NewSetProfileIdentitiesOptions : Instantiate SetProfileIdentitiesOptions

func (*IamIdentityV1) NewSetProfileIdentityOptions added in v0.40.0 

func (*IamIdentityV1) NewSetProfileIdentityOptions(profileID string, identityType string, identifier string, typeVar string) *SetProfileIdentityOptions

NewSetProfileIdentityOptions : Instantiate SetProfileIdentityOptions

func (*IamIdentityV1) NewTemplateProfileComponentRequest added in v0.42.0 

func (*IamIdentityV1) NewTemplateProfileComponentRequest(name string) (_model *TemplateProfileComponentRequest, err error)

NewTemplateProfileComponentRequest : Instantiate TemplateProfileComponentRequest (Generic Model Constructor)

func (*IamIdentityV1) NewTrustedProfileTemplateClaimRule added in v0.42.0 

func (*IamIdentityV1) NewTrustedProfileTemplateClaimRule(typeVar string, conditions []ProfileClaimRuleConditions) (_model *TrustedProfileTemplateClaimRule, err error)

NewTrustedProfileTemplateClaimRule : Instantiate TrustedProfileTemplateClaimRule (Generic Model Constructor)

func (*IamIdentityV1) NewUnlockAPIKeyOptions added in v0.17.2 

func (*IamIdentityV1) NewUnlockAPIKeyOptions(id string) *UnlockAPIKeyOptions

NewUnlockAPIKeyOptions : Instantiate UnlockAPIKeyOptions

func (*IamIdentityV1) NewUnlockServiceIDOptions added in v0.17.2 

func (*IamIdentityV1) NewUnlockServiceIDOptions(id string) *UnlockServiceIDOptions

NewUnlockServiceIDOptions : Instantiate UnlockServiceIDOptions

func (*IamIdentityV1) NewUpdateAPIKeyOptions added in v0.17.2 

func (*IamIdentityV1) NewUpdateAPIKeyOptions(id string, ifMatch string) *UpdateAPIKeyOptions

NewUpdateAPIKeyOptions : Instantiate UpdateAPIKeyOptions

func (*IamIdentityV1) NewUpdateAccountSettingsAssignmentOptions added in v0.42.0 

func (*IamIdentityV1) NewUpdateAccountSettingsAssignmentOptions(assignmentID string, ifMatch string, templateVersion int64) *UpdateAccountSettingsAssignmentOptions

NewUpdateAccountSettingsAssignmentOptions : Instantiate UpdateAccountSettingsAssignmentOptions

func (*IamIdentityV1) NewUpdateAccountSettingsOptions added in v0.17.17 

func (*IamIdentityV1) NewUpdateAccountSettingsOptions(ifMatch string, accountID string) *UpdateAccountSettingsOptions

NewUpdateAccountSettingsOptions : Instantiate UpdateAccountSettingsOptions

func (*IamIdentityV1) NewUpdateAccountSettingsTemplateVersionOptions added in v0.42.0 

func (*IamIdentityV1) NewUpdateAccountSettingsTemplateVersionOptions(ifMatch string, templateID string, version string) *UpdateAccountSettingsTemplateVersionOptions

NewUpdateAccountSettingsTemplateVersionOptions : Instantiate UpdateAccountSettingsTemplateVersionOptions

func (*IamIdentityV1) NewUpdateClaimRuleOptions added in v0.20.0 

func (*IamIdentityV1) NewUpdateClaimRuleOptions(profileID string, ruleID string, ifMatch string, typeVar string, conditions []ProfileClaimRuleConditions) *UpdateClaimRuleOptions

NewUpdateClaimRuleOptions : Instantiate UpdateClaimRuleOptions

func (*IamIdentityV1) NewUpdateProfileOptions added in v0.20.0 

func (*IamIdentityV1) NewUpdateProfileOptions(profileID string, ifMatch string) *UpdateProfileOptions

NewUpdateProfileOptions : Instantiate UpdateProfileOptions

func (*IamIdentityV1) NewUpdateProfileTemplateVersionOptions added in v0.42.0 

func (*IamIdentityV1) NewUpdateProfileTemplateVersionOptions(ifMatch string, templateID string, version string) *UpdateProfileTemplateVersionOptions

NewUpdateProfileTemplateVersionOptions : Instantiate UpdateProfileTemplateVersionOptions

func (*IamIdentityV1) NewUpdateServiceIDOptions added in v0.17.2 

func (*IamIdentityV1) NewUpdateServiceIDOptions(id string, ifMatch string) *UpdateServiceIDOptions

NewUpdateServiceIDOptions : Instantiate UpdateServiceIDOptions

func (*IamIdentityV1) NewUpdateTrustedProfileAssignmentOptions added in v0.42.0 

func (*IamIdentityV1) NewUpdateTrustedProfileAssignmentOptions(assignmentID string, ifMatch string, templateVersion int64) *UpdateTrustedProfileAssignmentOptions

NewUpdateTrustedProfileAssignmentOptions : Instantiate UpdateTrustedProfileAssignmentOptions

func (*IamIdentityV1) SetDefaultHeaders added in v0.12.2 

func (iamIdentity *IamIdentityV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*IamIdentityV1) SetEnableGzipCompression added in v0.12.1 

func (iamIdentity *IamIdentityV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*IamIdentityV1) SetProfileIdentities added in v0.40.0 

func (iamIdentity *IamIdentityV1) SetProfileIdentities(setProfileIdentitiesOptions *SetProfileIdentitiesOptions) (result *ProfileIdentitiesResponse, response *core.DetailedResponse, err error)

SetProfileIdentities : Update the list of identities that can assume the trusted profile Update the list of identities that can assume the trusted profile.

func (*IamIdentityV1) SetProfileIdentitiesWithContext added in v0.40.0 

func (iamIdentity *IamIdentityV1) SetProfileIdentitiesWithContext(ctx context.Context, setProfileIdentitiesOptions *SetProfileIdentitiesOptions) (result *ProfileIdentitiesResponse, response *core.DetailedResponse, err error)

SetProfileIdentitiesWithContext is an alternate form of the SetProfileIdentities method which supports a Context parameter

func (*IamIdentityV1) SetProfileIdentity added in v0.40.0 

func (iamIdentity *IamIdentityV1) SetProfileIdentity(setProfileIdentityOptions *SetProfileIdentityOptions) (result *ProfileIdentityResponse, response *core.DetailedResponse, err error)

SetProfileIdentity : Add a specific identity that can assume the trusted profile Add a specific identity that can assume the trusted profile.

func (*IamIdentityV1) SetProfileIdentityWithContext added in v0.40.0 

func (iamIdentity *IamIdentityV1) SetProfileIdentityWithContext(ctx context.Context, setProfileIdentityOptions *SetProfileIdentityOptions) (result *ProfileIdentityResponse, response *core.DetailedResponse, err error)

SetProfileIdentityWithContext is an alternate form of the SetProfileIdentity method which supports a Context parameter

func (*IamIdentityV1) SetServiceURL 

func (iamIdentity *IamIdentityV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*IamIdentityV1) UnlockAPIKey added in v0.17.2 

func (iamIdentity *IamIdentityV1) UnlockAPIKey(unlockAPIKeyOptions *UnlockAPIKeyOptions) (response *core.DetailedResponse, err error)

UnlockAPIKey : Unlock the API key Unlocks an API key by ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.

func (*IamIdentityV1) UnlockAPIKeyWithContext added in v0.17.2 

func (iamIdentity *IamIdentityV1) UnlockAPIKeyWithContext(ctx context.Context, unlockAPIKeyOptions *UnlockAPIKeyOptions) (response *core.DetailedResponse, err error)

UnlockAPIKeyWithContext is an alternate form of the UnlockAPIKey method which supports a Context parameter

func (*IamIdentityV1) UnlockServiceID 

func (iamIdentity *IamIdentityV1) UnlockServiceID(unlockServiceIDOptions *UnlockServiceIDOptions) (response *core.DetailedResponse, err error)

UnlockServiceID : Unlock the service ID Unlocks a service ID by ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.

func (*IamIdentityV1) UnlockServiceIDWithContext added in v0.12.1 

func (iamIdentity *IamIdentityV1) UnlockServiceIDWithContext(ctx context.Context, unlockServiceIDOptions *UnlockServiceIDOptions) (response *core.DetailedResponse, err error)

UnlockServiceIDWithContext is an alternate form of the UnlockServiceID method which supports a Context parameter

func (*IamIdentityV1) UpdateAPIKey added in v0.17.2 

func (iamIdentity *IamIdentityV1) UpdateAPIKey(updateAPIKeyOptions *UpdateAPIKeyOptions) (result *APIKey, response *core.DetailedResponse, err error)

UpdateAPIKey : Updates an API key Updates properties of an API key. This does NOT affect existing access tokens. Their token content will stay unchanged until the access token is refreshed. To update an API key, pass the property to be modified. To delete one property's value, pass the property with an empty value "".Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.

func (*IamIdentityV1) UpdateAPIKeyWithContext added in v0.17.2 

func (iamIdentity *IamIdentityV1) UpdateAPIKeyWithContext(ctx context.Context, updateAPIKeyOptions *UpdateAPIKeyOptions) (result *APIKey, response *core.DetailedResponse, err error)

UpdateAPIKeyWithContext is an alternate form of the UpdateAPIKey method which supports a Context parameter

func (*IamIdentityV1) UpdateAccountSettings added in v0.17.17 

func (iamIdentity *IamIdentityV1) UpdateAccountSettings(updateAccountSettingsOptions *UpdateAccountSettingsOptions) (result *AccountSettingsResponse, response *core.DetailedResponse, err error)

UpdateAccountSettings : Update account configurations Allows a user to configure settings on their account with regards to MFA, MFA excemption list, session lifetimes, access control for creating new identities, and enforcing IP restrictions on token creation.

func (*IamIdentityV1) UpdateAccountSettingsAssignment added in v0.42.0 

func (iamIdentity *IamIdentityV1) UpdateAccountSettingsAssignment(updateAccountSettingsAssignmentOptions *UpdateAccountSettingsAssignmentOptions) (result *TemplateAssignmentResponse, response *core.DetailedResponse, err error)

UpdateAccountSettingsAssignment : Update assignment Update an account settings assignment. Call this method to retry failed assignments or migrate the settings in child accounts to a new version.

func (*IamIdentityV1) UpdateAccountSettingsAssignmentWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) UpdateAccountSettingsAssignmentWithContext(ctx context.Context, updateAccountSettingsAssignmentOptions *UpdateAccountSettingsAssignmentOptions) (result *TemplateAssignmentResponse, response *core.DetailedResponse, err error)

UpdateAccountSettingsAssignmentWithContext is an alternate form of the UpdateAccountSettingsAssignment method which supports a Context parameter

func (*IamIdentityV1) UpdateAccountSettingsTemplateVersion added in v0.42.0 

func (iamIdentity *IamIdentityV1) UpdateAccountSettingsTemplateVersion(updateAccountSettingsTemplateVersionOptions *UpdateAccountSettingsTemplateVersionOptions) (result *AccountSettingsTemplateResponse, response *core.DetailedResponse, err error)

UpdateAccountSettingsTemplateVersion : Update version of an account settings template Update a specific version of an account settings template in an Enterprise Account.

func (*IamIdentityV1) UpdateAccountSettingsTemplateVersionWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) UpdateAccountSettingsTemplateVersionWithContext(ctx context.Context, updateAccountSettingsTemplateVersionOptions *UpdateAccountSettingsTemplateVersionOptions) (result *AccountSettingsTemplateResponse, response *core.DetailedResponse, err error)

UpdateAccountSettingsTemplateVersionWithContext is an alternate form of the UpdateAccountSettingsTemplateVersion method which supports a Context parameter

func (*IamIdentityV1) UpdateAccountSettingsWithContext added in v0.17.17 

func (iamIdentity *IamIdentityV1) UpdateAccountSettingsWithContext(ctx context.Context, updateAccountSettingsOptions *UpdateAccountSettingsOptions) (result *AccountSettingsResponse, response *core.DetailedResponse, err error)

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

func (*IamIdentityV1) UpdateClaimRule added in v0.20.0 

func (iamIdentity *IamIdentityV1) UpdateClaimRule(updateClaimRuleOptions *UpdateClaimRuleOptions) (result *ProfileClaimRule, response *core.DetailedResponse, err error)

UpdateClaimRule : Update claim rule for a trusted profile Update a specific claim rule for a given trusted profile ID and rule ID.

func (*IamIdentityV1) UpdateClaimRuleWithContext added in v0.20.0 

func (iamIdentity *IamIdentityV1) UpdateClaimRuleWithContext(ctx context.Context, updateClaimRuleOptions *UpdateClaimRuleOptions) (result *ProfileClaimRule, response *core.DetailedResponse, err error)

UpdateClaimRuleWithContext is an alternate form of the UpdateClaimRule method which supports a Context parameter

func (*IamIdentityV1) UpdateProfile added in v0.20.0 

func (iamIdentity *IamIdentityV1) UpdateProfile(updateProfileOptions *UpdateProfileOptions) (result *TrustedProfile, response *core.DetailedResponse, err error)

UpdateProfile : Update a trusted profile Update the name or description of an existing trusted profile.

func (*IamIdentityV1) UpdateProfileTemplateVersion added in v0.42.0 

func (iamIdentity *IamIdentityV1) UpdateProfileTemplateVersion(updateProfileTemplateVersionOptions *UpdateProfileTemplateVersionOptions) (result *TrustedProfileTemplateResponse, response *core.DetailedResponse, err error)

UpdateProfileTemplateVersion : Update version of trusted profile template Update a specific version of a trusted profile template in an enterprise account.

func (*IamIdentityV1) UpdateProfileTemplateVersionWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) UpdateProfileTemplateVersionWithContext(ctx context.Context, updateProfileTemplateVersionOptions *UpdateProfileTemplateVersionOptions) (result *TrustedProfileTemplateResponse, response *core.DetailedResponse, err error)

UpdateProfileTemplateVersionWithContext is an alternate form of the UpdateProfileTemplateVersion method which supports a Context parameter

func (*IamIdentityV1) UpdateProfileWithContext added in v0.20.0 

func (iamIdentity *IamIdentityV1) UpdateProfileWithContext(ctx context.Context, updateProfileOptions *UpdateProfileOptions) (result *TrustedProfile, response *core.DetailedResponse, err error)

UpdateProfileWithContext is an alternate form of the UpdateProfile method which supports a Context parameter

func (*IamIdentityV1) UpdateServiceID 

func (iamIdentity *IamIdentityV1) UpdateServiceID(updateServiceIDOptions *UpdateServiceIDOptions) (result *ServiceID, response *core.DetailedResponse, err error)

UpdateServiceID : Update service ID Updates properties of a service ID. This does NOT affect existing access tokens. Their token content will stay unchanged until the access token is refreshed. To update a service ID, pass the property to be modified. To delete one property's value, pass the property with an empty value "".Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. Note: apikey details are only included in the response when creating a Service ID with an apikey.

func (*IamIdentityV1) UpdateServiceIDWithContext added in v0.12.1 

func (iamIdentity *IamIdentityV1) UpdateServiceIDWithContext(ctx context.Context, updateServiceIDOptions *UpdateServiceIDOptions) (result *ServiceID, response *core.DetailedResponse, err error)

UpdateServiceIDWithContext is an alternate form of the UpdateServiceID method which supports a Context parameter

func (*IamIdentityV1) UpdateTrustedProfileAssignment added in v0.42.0 

func (iamIdentity *IamIdentityV1) UpdateTrustedProfileAssignment(updateTrustedProfileAssignmentOptions *UpdateTrustedProfileAssignmentOptions) (result *TemplateAssignmentResponse, response *core.DetailedResponse, err error)

UpdateTrustedProfileAssignment : Update assignment Update a trusted profile assignment. Call this method to retry failed assignments or migrate the trusted profile in child accounts to a new version.

func (*IamIdentityV1) UpdateTrustedProfileAssignmentWithContext added in v0.42.0 

func (iamIdentity *IamIdentityV1) UpdateTrustedProfileAssignmentWithContext(ctx context.Context, updateTrustedProfileAssignmentOptions *UpdateTrustedProfileAssignmentOptions) (result *TemplateAssignmentResponse, response *core.DetailedResponse, err error)

UpdateTrustedProfileAssignmentWithContext is an alternate form of the UpdateTrustedProfileAssignment method which supports a Context parameter

type IamIdentityV1Options 

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

IamIdentityV1Options : Service options

type ListAPIKeysOptions added in v0.17.2 

type ListAPIKeysOptions struct {
	// Account ID of the API keys 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,omitempty"`

	// IAM ID of the API keys to be queried. The IAM ID may be that of a user or a service. For a user IAM ID iam_id must
	// match the Authorization token.
	IamID *string `json:"iam_id,omitempty"`

	// Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
	Pagesize *int64 `json:"pagesize,omitempty"`

	// Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
	Pagetoken *string `json:"pagetoken,omitempty"`

	// Optional parameter to define the scope of the queried API keys. Can be 'entity' (default) or 'account'.
	Scope *string `json:"scope,omitempty"`

	// Optional parameter to filter the type of the queried API keys. Can be 'user' or 'serviceid'.
	Type *string `json:"type,omitempty"`

	// Optional sort property, valid values are name, description, created_at and created_by. If specified, the items are
	// sorted by the value of this property.
	Sort *string `json:"sort,omitempty"`

	// Optional sort order, valid values are asc and desc. Default: asc.
	Order *string `json:"order,omitempty"`

	// Defines if the entity history is included in the response.
	IncludeHistory *bool `json:"include_history,omitempty"`

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

ListAPIKeysOptions : The ListAPIKeys options.

func (*ListAPIKeysOptions) SetAccountID added in v0.17.2 

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

SetAccountID : Allow user to set AccountID

func (*ListAPIKeysOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*ListAPIKeysOptions) SetIamID added in v0.17.2 

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

SetIamID : Allow user to set IamID

func (*ListAPIKeysOptions) SetIncludeHistory added in v0.17.2 

func (_options *ListAPIKeysOptions) SetIncludeHistory(includeHistory bool) *ListAPIKeysOptions

SetIncludeHistory : Allow user to set IncludeHistory

func (*ListAPIKeysOptions) SetOrder added in v0.17.2 

func (_options *ListAPIKeysOptions) SetOrder(order string) *ListAPIKeysOptions

SetOrder : Allow user to set Order

func (*ListAPIKeysOptions) SetPagesize added in v0.17.2 

func (_options *ListAPIKeysOptions) SetPagesize(pagesize int64) *ListAPIKeysOptions

SetPagesize : Allow user to set Pagesize

func (*ListAPIKeysOptions) SetPagetoken added in v0.17.2 

func (_options *ListAPIKeysOptions) SetPagetoken(pagetoken string) *ListAPIKeysOptions

SetPagetoken : Allow user to set Pagetoken

func (*ListAPIKeysOptions) SetScope added in v0.17.2 

func (_options *ListAPIKeysOptions) SetScope(scope string) *ListAPIKeysOptions

SetScope : Allow user to set Scope

func (*ListAPIKeysOptions) SetSort added in v0.17.2 

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

SetSort : Allow user to set Sort

func (*ListAPIKeysOptions) SetType added in v0.17.2 

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

SetType : Allow user to set Type

type ListAccountSettingsAssignmentsOptions added in v0.42.0 

type ListAccountSettingsAssignmentsOptions struct {
	// Account ID of the Assignments to query. This parameter is required unless using a pagetoken.
	AccountID *string `json:"account_id,omitempty"`

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

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

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

	// Filter results by the assignment's target type.
	TargetType *string `json:"target_type,omitempty"`

	// Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
	Limit *int64 `json:"limit,omitempty"`

	// Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
	Pagetoken *string `json:"pagetoken,omitempty"`

	// If specified, the items are sorted by the value of this property.
	Sort *string `json:"sort,omitempty"`

	// Sort order.
	Order *string `json:"order,omitempty"`

	// Defines if the entity history is included in the response.
	IncludeHistory *bool `json:"include_history,omitempty"`

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

ListAccountSettingsAssignmentsOptions : The ListAccountSettingsAssignments options.

func (*ListAccountSettingsAssignmentsOptions) SetAccountID added in v0.42.0 

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

SetAccountID : Allow user to set AccountID

func (*ListAccountSettingsAssignmentsOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*ListAccountSettingsAssignmentsOptions) SetIncludeHistory added in v0.42.0 

func (_options *ListAccountSettingsAssignmentsOptions) SetIncludeHistory(includeHistory bool) *ListAccountSettingsAssignmentsOptions

SetIncludeHistory : Allow user to set IncludeHistory

func (*ListAccountSettingsAssignmentsOptions) SetLimit added in v0.42.0 

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

SetLimit : Allow user to set Limit

func (*ListAccountSettingsAssignmentsOptions) SetOrder added in v0.42.0 

func (_options *ListAccountSettingsAssignmentsOptions) SetOrder(order string) *ListAccountSettingsAssignmentsOptions

SetOrder : Allow user to set Order

func (*ListAccountSettingsAssignmentsOptions) SetPagetoken added in v0.42.0 

func (_options *ListAccountSettingsAssignmentsOptions) SetPagetoken(pagetoken string) *ListAccountSettingsAssignmentsOptions

SetPagetoken : Allow user to set Pagetoken

func (*ListAccountSettingsAssignmentsOptions) SetSort added in v0.42.0 

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

SetSort : Allow user to set Sort

func (*ListAccountSettingsAssignmentsOptions) SetTarget added in v0.42.0 

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

SetTarget : Allow user to set Target

func (*ListAccountSettingsAssignmentsOptions) SetTargetType added in v0.42.0 

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

SetTargetType : Allow user to set TargetType

func (*ListAccountSettingsAssignmentsOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

func (*ListAccountSettingsAssignmentsOptions) SetTemplateVersion added in v0.42.0 

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

SetTemplateVersion : Allow user to set TemplateVersion

type ListAccountSettingsTemplatesOptions added in v0.42.0 

type ListAccountSettingsTemplatesOptions struct {
	// Account ID of the account settings templates to query. This parameter is required unless using a pagetoken.
	AccountID *string `json:"account_id,omitempty"`

	// Optional size of a single page.
	Limit *string `json:"limit,omitempty"`

	// Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
	Pagetoken *string `json:"pagetoken,omitempty"`

	// Optional sort property. If specified, the returned templated are sorted according to this property.
	Sort *string `json:"sort,omitempty"`

	// Optional sort order.
	Order *string `json:"order,omitempty"`

	// Defines if the entity history is included in the response.
	IncludeHistory *string `json:"include_history,omitempty"`

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

ListAccountSettingsTemplatesOptions : The ListAccountSettingsTemplates options.

func (*ListAccountSettingsTemplatesOptions) SetAccountID added in v0.42.0 

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

SetAccountID : Allow user to set AccountID

func (*ListAccountSettingsTemplatesOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*ListAccountSettingsTemplatesOptions) SetIncludeHistory added in v0.42.0 

func (_options *ListAccountSettingsTemplatesOptions) SetIncludeHistory(includeHistory string) *ListAccountSettingsTemplatesOptions

SetIncludeHistory : Allow user to set IncludeHistory

func (*ListAccountSettingsTemplatesOptions) SetLimit added in v0.42.0 

func (_options *ListAccountSettingsTemplatesOptions) SetLimit(limit string) *ListAccountSettingsTemplatesOptions

SetLimit : Allow user to set Limit

func (*ListAccountSettingsTemplatesOptions) SetOrder added in v0.42.0 

func (_options *ListAccountSettingsTemplatesOptions) SetOrder(order string) *ListAccountSettingsTemplatesOptions

SetOrder : Allow user to set Order

func (*ListAccountSettingsTemplatesOptions) SetPagetoken added in v0.42.0 

func (_options *ListAccountSettingsTemplatesOptions) SetPagetoken(pagetoken string) *ListAccountSettingsTemplatesOptions

SetPagetoken : Allow user to set Pagetoken

func (*ListAccountSettingsTemplatesOptions) SetSort added in v0.42.0 

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

SetSort : Allow user to set Sort

type ListClaimRulesOptions added in v0.20.0 

type ListClaimRulesOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

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

ListClaimRulesOptions : The ListClaimRules options.

func (*ListClaimRulesOptions) SetHeaders added in v0.20.0 

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

SetHeaders : Allow user to set Headers

func (*ListClaimRulesOptions) SetProfileID added in v0.20.0 

func (_options *ListClaimRulesOptions) SetProfileID(profileID string) *ListClaimRulesOptions

SetProfileID : Allow user to set ProfileID

type ListLinksOptions added in v0.20.1 

type ListLinksOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

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

ListLinksOptions : The ListLinks options.

func (*ListLinksOptions) SetHeaders added in v0.20.1 

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

SetHeaders : Allow user to set Headers

func (*ListLinksOptions) SetProfileID added in v0.20.1 

func (_options *ListLinksOptions) SetProfileID(profileID string) *ListLinksOptions

SetProfileID : Allow user to set ProfileID

type ListProfileTemplatesOptions added in v0.42.0 

type ListProfileTemplatesOptions struct {
	// Account ID of the trusted profile templates to query. This parameter is required unless using a pagetoken.
	AccountID *string `json:"account_id,omitempty"`

	// Optional size of a single page.
	Limit *string `json:"limit,omitempty"`

	// Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
	Pagetoken *string `json:"pagetoken,omitempty"`

	// Optional sort property. If specified, the returned templates are sorted according to this property.
	Sort *string `json:"sort,omitempty"`

	// Optional sort order.
	Order *string `json:"order,omitempty"`

	// Defines if the entity history is included in the response.
	IncludeHistory *string `json:"include_history,omitempty"`

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

ListProfileTemplatesOptions : The ListProfileTemplates options.

func (*ListProfileTemplatesOptions) SetAccountID added in v0.42.0 

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

SetAccountID : Allow user to set AccountID

func (*ListProfileTemplatesOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*ListProfileTemplatesOptions) SetIncludeHistory added in v0.42.0 

func (_options *ListProfileTemplatesOptions) SetIncludeHistory(includeHistory string) *ListProfileTemplatesOptions

SetIncludeHistory : Allow user to set IncludeHistory

func (*ListProfileTemplatesOptions) SetLimit added in v0.42.0 

func (_options *ListProfileTemplatesOptions) SetLimit(limit string) *ListProfileTemplatesOptions

SetLimit : Allow user to set Limit

func (*ListProfileTemplatesOptions) SetOrder added in v0.42.0 

func (_options *ListProfileTemplatesOptions) SetOrder(order string) *ListProfileTemplatesOptions

SetOrder : Allow user to set Order

func (*ListProfileTemplatesOptions) SetPagetoken added in v0.42.0 

func (_options *ListProfileTemplatesOptions) SetPagetoken(pagetoken string) *ListProfileTemplatesOptions

SetPagetoken : Allow user to set Pagetoken

func (*ListProfileTemplatesOptions) SetSort added in v0.42.0 

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

SetSort : Allow user to set Sort

type ListProfilesOptions added in v0.20.1 

type ListProfilesOptions struct {
	// Account ID to query for trusted profiles.
	AccountID *string `json:"account_id" validate:"required"`

	// Name of the trusted profile to query.
	Name *string `json:"name,omitempty"`

	// Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
	Pagesize *int64 `json:"pagesize,omitempty"`

	// Optional sort property, valid values are name, description, created_at and modified_at. If specified, the items are
	// sorted by the value of this property.
	Sort *string `json:"sort,omitempty"`

	// Optional sort order, valid values are asc and desc. Default: asc.
	Order *string `json:"order,omitempty"`

	// Defines if the entity history is included in the response.
	IncludeHistory *bool `json:"include_history,omitempty"`

	// Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
	Pagetoken *string `json:"pagetoken,omitempty"`

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

ListProfilesOptions : The ListProfiles options.

func (*ListProfilesOptions) SetAccountID added in v0.20.1 

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

SetAccountID : Allow user to set AccountID

func (*ListProfilesOptions) SetHeaders added in v0.20.1 

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

SetHeaders : Allow user to set Headers

func (*ListProfilesOptions) SetIncludeHistory added in v0.20.1 

func (_options *ListProfilesOptions) SetIncludeHistory(includeHistory bool) *ListProfilesOptions

SetIncludeHistory : Allow user to set IncludeHistory

func (*ListProfilesOptions) SetName added in v0.20.1 

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

SetName : Allow user to set Name

func (*ListProfilesOptions) SetOrder added in v0.20.1 

func (_options *ListProfilesOptions) SetOrder(order string) *ListProfilesOptions

SetOrder : Allow user to set Order

func (*ListProfilesOptions) SetPagesize added in v0.20.1 

func (_options *ListProfilesOptions) SetPagesize(pagesize int64) *ListProfilesOptions

SetPagesize : Allow user to set Pagesize

func (*ListProfilesOptions) SetPagetoken added in v0.20.1 

func (_options *ListProfilesOptions) SetPagetoken(pagetoken string) *ListProfilesOptions

SetPagetoken : Allow user to set Pagetoken

func (*ListProfilesOptions) SetSort added in v0.20.1 

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

SetSort : Allow user to set Sort

type ListServiceIdsOptions 

type ListServiceIdsOptions struct {
	// Account ID of the service ID(s) to query. This parameter is required (unless using a pagetoken).
	AccountID *string `json:"account_id,omitempty"`

	// Name of the service ID(s) to query. Optional.20 items per page. Valid range is 1 to 100.
	Name *string `json:"name,omitempty"`

	// Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
	Pagesize *int64 `json:"pagesize,omitempty"`

	// Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
	Pagetoken *string `json:"pagetoken,omitempty"`

	// Optional sort property, valid values are name, description, created_at and modified_at. If specified, the items are
	// sorted by the value of this property.
	Sort *string `json:"sort,omitempty"`

	// Optional sort order, valid values are asc and desc. Default: asc.
	Order *string `json:"order,omitempty"`

	// Defines if the entity history is included in the response.
	IncludeHistory *bool `json:"include_history,omitempty"`

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

ListServiceIdsOptions : The ListServiceIds options.

func (*ListServiceIdsOptions) SetAccountID 

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

SetAccountID : Allow user to set AccountID

func (*ListServiceIdsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListServiceIdsOptions) SetIncludeHistory 

func (_options *ListServiceIdsOptions) SetIncludeHistory(includeHistory bool) *ListServiceIdsOptions

SetIncludeHistory : Allow user to set IncludeHistory

func (*ListServiceIdsOptions) SetName 

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

SetName : Allow user to set Name

func (*ListServiceIdsOptions) SetOrder 

func (_options *ListServiceIdsOptions) SetOrder(order string) *ListServiceIdsOptions

SetOrder : Allow user to set Order

func (*ListServiceIdsOptions) SetPagesize 

func (_options *ListServiceIdsOptions) SetPagesize(pagesize int64) *ListServiceIdsOptions

SetPagesize : Allow user to set Pagesize

func (*ListServiceIdsOptions) SetPagetoken 

func (_options *ListServiceIdsOptions) SetPagetoken(pagetoken string) *ListServiceIdsOptions

SetPagetoken : Allow user to set Pagetoken

func (*ListServiceIdsOptions) SetSort 

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

SetSort : Allow user to set Sort

type ListTrustedProfileAssignmentsOptions added in v0.42.0 

type ListTrustedProfileAssignmentsOptions struct {
	// Account ID of the Assignments to query. This parameter is required unless using a pagetoken.
	AccountID *string `json:"account_id,omitempty"`

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

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

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

	// Filter results by the assignment's target type.
	TargetType *string `json:"target_type,omitempty"`

	// Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
	Limit *int64 `json:"limit,omitempty"`

	// Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
	Pagetoken *string `json:"pagetoken,omitempty"`

	// If specified, the items are sorted by the value of this property.
	Sort *string `json:"sort,omitempty"`

	// Sort order.
	Order *string `json:"order,omitempty"`

	// Defines if the entity history is included in the response.
	IncludeHistory *bool `json:"include_history,omitempty"`

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

ListTrustedProfileAssignmentsOptions : The ListTrustedProfileAssignments options.

func (*ListTrustedProfileAssignmentsOptions) SetAccountID added in v0.42.0 

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

SetAccountID : Allow user to set AccountID

func (*ListTrustedProfileAssignmentsOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*ListTrustedProfileAssignmentsOptions) SetIncludeHistory added in v0.42.0 

func (_options *ListTrustedProfileAssignmentsOptions) SetIncludeHistory(includeHistory bool) *ListTrustedProfileAssignmentsOptions

SetIncludeHistory : Allow user to set IncludeHistory

func (*ListTrustedProfileAssignmentsOptions) SetLimit added in v0.42.0 

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

SetLimit : Allow user to set Limit

func (*ListTrustedProfileAssignmentsOptions) SetOrder added in v0.42.0 

func (_options *ListTrustedProfileAssignmentsOptions) SetOrder(order string) *ListTrustedProfileAssignmentsOptions

SetOrder : Allow user to set Order

func (*ListTrustedProfileAssignmentsOptions) SetPagetoken added in v0.42.0 

func (_options *ListTrustedProfileAssignmentsOptions) SetPagetoken(pagetoken string) *ListTrustedProfileAssignmentsOptions

SetPagetoken : Allow user to set Pagetoken

func (*ListTrustedProfileAssignmentsOptions) SetSort added in v0.42.0 

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

SetSort : Allow user to set Sort

func (*ListTrustedProfileAssignmentsOptions) SetTarget added in v0.42.0 

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

SetTarget : Allow user to set Target

func (*ListTrustedProfileAssignmentsOptions) SetTargetType added in v0.42.0 

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

SetTargetType : Allow user to set TargetType

func (*ListTrustedProfileAssignmentsOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

func (*ListTrustedProfileAssignmentsOptions) SetTemplateVersion added in v0.42.0 

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

SetTemplateVersion : Allow user to set TemplateVersion

type ListVersionsOfAccountSettingsTemplateOptions added in v0.42.0 

type ListVersionsOfAccountSettingsTemplateOptions struct {
	// ID of the account settings template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// Optional size of a single page.
	Limit *string `json:"limit,omitempty"`

	// Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
	Pagetoken *string `json:"pagetoken,omitempty"`

	// Optional sort property. If specified, the returned templated are sorted according to this property.
	Sort *string `json:"sort,omitempty"`

	// Optional sort order.
	Order *string `json:"order,omitempty"`

	// Defines if the entity history is included in the response.
	IncludeHistory *string `json:"include_history,omitempty"`

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

ListVersionsOfAccountSettingsTemplateOptions : The ListVersionsOfAccountSettingsTemplate options.

func (*ListVersionsOfAccountSettingsTemplateOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*ListVersionsOfAccountSettingsTemplateOptions) SetIncludeHistory added in v0.42.0 

func (_options *ListVersionsOfAccountSettingsTemplateOptions) SetIncludeHistory(includeHistory string) *ListVersionsOfAccountSettingsTemplateOptions

SetIncludeHistory : Allow user to set IncludeHistory

func (*ListVersionsOfAccountSettingsTemplateOptions) SetLimit added in v0.42.0 

func (_options *ListVersionsOfAccountSettingsTemplateOptions) SetLimit(limit string) *ListVersionsOfAccountSettingsTemplateOptions

SetLimit : Allow user to set Limit

func (*ListVersionsOfAccountSettingsTemplateOptions) SetOrder added in v0.42.0 

func (_options *ListVersionsOfAccountSettingsTemplateOptions) SetOrder(order string) *ListVersionsOfAccountSettingsTemplateOptions

SetOrder : Allow user to set Order

func (*ListVersionsOfAccountSettingsTemplateOptions) SetPagetoken added in v0.42.0 

func (_options *ListVersionsOfAccountSettingsTemplateOptions) SetPagetoken(pagetoken string) *ListVersionsOfAccountSettingsTemplateOptions

SetPagetoken : Allow user to set Pagetoken

func (*ListVersionsOfAccountSettingsTemplateOptions) SetSort added in v0.42.0 

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

SetSort : Allow user to set Sort

func (*ListVersionsOfAccountSettingsTemplateOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

type ListVersionsOfProfileTemplateOptions added in v0.42.0 

type ListVersionsOfProfileTemplateOptions struct {
	// ID of the trusted profile template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// Optional size of a single page.
	Limit *string `json:"limit,omitempty"`

	// Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
	Pagetoken *string `json:"pagetoken,omitempty"`

	// Optional sort property. If specified, the returned templated are sorted according to this property.
	Sort *string `json:"sort,omitempty"`

	// Optional sort order.
	Order *string `json:"order,omitempty"`

	// Defines if the entity history is included in the response.
	IncludeHistory *string `json:"include_history,omitempty"`

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

ListVersionsOfProfileTemplateOptions : The ListVersionsOfProfileTemplate options.

func (*ListVersionsOfProfileTemplateOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*ListVersionsOfProfileTemplateOptions) SetIncludeHistory added in v0.42.0 

func (_options *ListVersionsOfProfileTemplateOptions) SetIncludeHistory(includeHistory string) *ListVersionsOfProfileTemplateOptions

SetIncludeHistory : Allow user to set IncludeHistory

func (*ListVersionsOfProfileTemplateOptions) SetLimit added in v0.42.0 

func (_options *ListVersionsOfProfileTemplateOptions) SetLimit(limit string) *ListVersionsOfProfileTemplateOptions

SetLimit : Allow user to set Limit

func (*ListVersionsOfProfileTemplateOptions) SetOrder added in v0.42.0 

func (_options *ListVersionsOfProfileTemplateOptions) SetOrder(order string) *ListVersionsOfProfileTemplateOptions

SetOrder : Allow user to set Order

func (*ListVersionsOfProfileTemplateOptions) SetPagetoken added in v0.42.0 

func (_options *ListVersionsOfProfileTemplateOptions) SetPagetoken(pagetoken string) *ListVersionsOfProfileTemplateOptions

SetPagetoken : Allow user to set Pagetoken

func (*ListVersionsOfProfileTemplateOptions) SetSort added in v0.42.0 

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

SetSort : Allow user to set Sort

func (*ListVersionsOfProfileTemplateOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

type LockAPIKeyOptions added in v0.17.2 

type LockAPIKeyOptions struct {
	// Unique ID of the API key.
	ID *string `json:"id" validate:"required,ne="`

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

LockAPIKeyOptions : The LockAPIKey options.

func (*LockAPIKeyOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*LockAPIKeyOptions) SetID added in v0.17.2 

func (_options *LockAPIKeyOptions) SetID(id string) *LockAPIKeyOptions

SetID : Allow user to set ID

type LockServiceIDOptions added in v0.17.2 

type LockServiceIDOptions struct {
	// Unique ID of the service ID.
	ID *string `json:"id" validate:"required,ne="`

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

LockServiceIDOptions : The LockServiceID options.

func (*LockServiceIDOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*LockServiceIDOptions) SetID added in v0.17.2 

func (_options *LockServiceIDOptions) SetID(id string) *LockServiceIDOptions

SetID : Allow user to set ID

type MfaEnrollmentTypeStatus added in v0.31.6 

type MfaEnrollmentTypeStatus struct {
	// Describes whether the enrollment type is required.
	Required *bool `json:"required" validate:"required"`

	// Describes whether the enrollment type is enrolled.
	Enrolled *bool `json:"enrolled" validate:"required"`
}

MfaEnrollmentTypeStatus : MfaEnrollmentTypeStatus struct

type MfaEnrollments added in v0.31.6 

type MfaEnrollments struct {
	// currently effective mfa type i.e. id_based_mfa or account_based_mfa.
	EffectiveMfaType *string `json:"effective_mfa_type" validate:"required"`

	IDBasedMfa *IDBasedMfaEnrollment `json:"id_based_mfa,omitempty"`

	AccountBasedMfa *AccountBasedMfaEnrollment `json:"account_based_mfa,omitempty"`
}

MfaEnrollments : MfaEnrollments struct

type PolicyTemplateReference added in v0.42.0 

type PolicyTemplateReference struct {
	// ID of Access Policy Template.
	ID *string `json:"id" validate:"required"`

	// Version of Access Policy Template.
	Version *string `json:"version" validate:"required"`
}

PolicyTemplateReference : Metadata for external access policy.

type ProfileClaimRule added in v0.20.0 

type ProfileClaimRule struct {
	// the unique identifier of the claim rule.
	ID *string `json:"id" validate:"required"`

	// version of the claim rule.
	EntityTag *string `json:"entity_tag" validate:"required"`

	// If set contains a date time string of the creation date in ISO format.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// If set contains a date time string of the last modification date in ISO format.
	ModifiedAt *strfmt.DateTime `json:"modified_at,omitempty"`

	// The optional claim rule name.
	Name *string `json:"name,omitempty"`

	// Type of the claim rule, either 'Profile-SAML' or 'Profile-CR'.
	Type *string `json:"type" validate:"required"`

	// The realm name of the Idp this claim rule applies to.
	RealmName *string `json:"realm_name,omitempty"`

	// Session expiration in seconds.
	Expiration *int64 `json:"expiration" validate:"required"`

	// The compute resource type. Not required if type is Profile-SAML. Valid values are VSI, IKS_SA, ROKS_SA.
	CrType *string `json:"cr_type,omitempty"`

	// Conditions of this claim rule.
	Conditions []ProfileClaimRuleConditions `json:"conditions" validate:"required"`
}

ProfileClaimRule : ProfileClaimRule struct

type ProfileClaimRuleConditions added in v0.20.0 

type ProfileClaimRuleConditions struct {
	// The claim to evaluate against. [Learn
	// more](/docs/account?topic=account-iam-condition-properties&interface=ui#cr-attribute-names).
	Claim *string `json:"claim" validate:"required"`

	// The operation to perform on the claim. valid values are EQUALS, NOT_EQUALS, EQUALS_IGNORE_CASE,
	// NOT_EQUALS_IGNORE_CASE, CONTAINS, IN.
	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"`
}

ProfileClaimRuleConditions : ProfileClaimRuleConditions struct

type ProfileClaimRuleList added in v0.20.0 

type ProfileClaimRuleList struct {
	// Context with key properties for problem determination.
	Context *ResponseContext `json:"context,omitempty"`

	// List of claim rules.
	Rules []ProfileClaimRule `json:"rules" validate:"required"`
}

ProfileClaimRuleList : ProfileClaimRuleList struct

type ProfileIdentitiesResponse added in v0.40.0 

type ProfileIdentitiesResponse struct {
	// Entity tag of the profile identities response.
	EntityTag *string `json:"entity_tag,omitempty"`

	// List of identities.
	Identities []ProfileIdentityResponse `json:"identities,omitempty"`
}

ProfileIdentitiesResponse : ProfileIdentitiesResponse struct

type ProfileIdentityRequest added in v0.42.0 

type ProfileIdentityRequest struct {
	// Identifier of the identity that can assume the trusted profiles. This can be a user identifier (IAM id), serviceid
	// or crn. Internally it uses account id of the service id for the identifier 'serviceid' and for the identifier 'crn'
	// it uses account id contained in the CRN.
	Identifier *string `json:"identifier" validate:"required"`

	// Type of the identity.
	Type *string `json:"type" validate:"required"`

	// Only valid for the type user. Accounts from which a user can assume the trusted profile.
	Accounts []string `json:"accounts,omitempty"`

	// Description of the identity that can assume the trusted profile. This is optional field for all the types of
	// identities. When this field is not set for the identity type 'serviceid' then the description of the service id is
	// used. Description is recommended for the identity type 'crn' E.g. 'Instance 1234 of IBM Cloud Service project'.
	Description *string `json:"description,omitempty"`
}

ProfileIdentityRequest : ProfileIdentityRequest struct

type ProfileIdentityResponse added in v0.42.0 

type ProfileIdentityResponse struct {
	// IAM ID of the identity.
	IamID *string `json:"iam_id" validate:"required"`

	// Identifier of the identity that can assume the trusted profiles. This can be a user identifier (IAM id), serviceid
	// or crn. Internally it uses account id of the service id for the identifier 'serviceid' and for the identifier 'crn'
	// it uses account id contained in the CRN.
	Identifier *string `json:"identifier" validate:"required"`

	// Type of the identity.
	Type *string `json:"type" validate:"required"`

	// Only valid for the type user. Accounts from which a user can assume the trusted profile.
	Accounts []string `json:"accounts,omitempty"`

	// Description of the identity that can assume the trusted profile. This is optional field for all the types of
	// identities. When this field is not set for the identity type 'serviceid' then the description of the service id is
	// used. Description is recommended for the identity type 'crn' E.g. 'Instance 1234 of IBM Cloud Service project'.
	Description *string `json:"description,omitempty"`
}

ProfileIdentityResponse : ProfileIdentityResponse struct 

type ProfileLink struct {
	// the unique identifier of the link.
	ID *string `json:"id" validate:"required"`

	// version of the link.
	EntityTag *string `json:"entity_tag" validate:"required"`

	// If set contains a date time string of the creation date in ISO format.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// If set contains a date time string of the last modification date in ISO format.
	ModifiedAt *strfmt.DateTime `json:"modified_at" validate:"required"`

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

	// The compute resource type. Valid values are VSI, IKS_SA, ROKS_SA.
	CrType *string `json:"cr_type" validate:"required"`

	Link *ProfileLinkLink `json:"link" validate:"required"`
}

ProfileLink : Link details. 

type ProfileLinkLink struct {
	// The CRN of the compute resource.
	CRN *string `json:"crn,omitempty"`

	// The compute resource namespace, only required if cr_type is IKS_SA or ROKS_SA.
	Namespace *string `json:"namespace,omitempty"`

	// Name of the compute resource, only required if cr_type is IKS_SA or ROKS_SA.
	Name *string `json:"name,omitempty"`
}

ProfileLinkLink : ProfileLinkLink struct 

type ProfileLinkList struct {
	// List of links to a trusted profile.
	Links []ProfileLink `json:"links" validate:"required"`
}

ProfileLinkList : ProfileLinkList struct

type Report added in v0.24.0 

type Report struct {
	// IAMid of the user who triggered the report.
	CreatedBy *string `json:"created_by" validate:"required"`

	// Unique reference used to generate the report.
	Reference *string `json:"reference" validate:"required"`

	// Duration in hours for which the report is generated.
	ReportDuration *string `json:"report_duration" validate:"required"`

	// Start time of the report.
	ReportStartTime *string `json:"report_start_time" validate:"required"`

	// End time of the report.
	ReportEndTime *string `json:"report_end_time" validate:"required"`

	// List of users.
	Users []UserActivity `json:"users,omitempty"`

	// List of apikeys.
	Apikeys []ApikeyActivity `json:"apikeys,omitempty"`

	// List of serviceids.
	Serviceids []EntityActivity `json:"serviceids,omitempty"`

	// List of profiles.
	Profiles []EntityActivity `json:"profiles,omitempty"`
}

Report : Report struct

type ReportMfaEnrollmentStatus added in v0.31.6 

type ReportMfaEnrollmentStatus struct {
	// IAMid of the user who triggered the report.
	CreatedBy *string `json:"created_by" validate:"required"`

	// Unique reference used to generate the report.
	Reference *string `json:"reference" validate:"required"`

	// Date time at which report is generated. Date is in ISO format.
	ReportTime *string `json:"report_time" validate:"required"`

	// BSS account id of the user who triggered the report.
	AccountID *string `json:"account_id" validate:"required"`

	// IMS account id of the user who triggered the report.
	ImsAccountID *string `json:"ims_account_id,omitempty"`

	// List of users.
	Users []UserReportMfaEnrollmentStatus `json:"users,omitempty"`
}

ReportMfaEnrollmentStatus : ReportMfaEnrollmentStatus struct

type ReportReference added in v0.24.0 

type ReportReference struct {
	// Reference for the report to be generated.
	Reference *string `json:"reference" validate:"required"`
}

ReportReference : ReportReference struct

type ResponseContext 

type ResponseContext struct {
	// The transaction ID of the inbound REST request.
	TransactionID *string `json:"transaction_id,omitempty"`

	// The operation of the inbound REST request.
	Operation *string `json:"operation,omitempty"`

	// The user agent of the inbound REST request.
	UserAgent *string `json:"user_agent,omitempty"`

	// The URL of that cluster.
	URL *string `json:"url,omitempty"`

	// The instance ID of the server instance processing the request.
	InstanceID *string `json:"instance_id,omitempty"`

	// The thread ID of the server instance processing the request.
	ThreadID *string `json:"thread_id,omitempty"`

	// The host of the server instance processing the request.
	Host *string `json:"host,omitempty"`

	// The start time of the request.
	StartTime *string `json:"start_time,omitempty"`

	// The finish time of the request.
	EndTime *string `json:"end_time,omitempty"`

	// The elapsed time in msec.
	ElapsedTime *string `json:"elapsed_time,omitempty"`

	// The cluster name.
	ClusterName *string `json:"cluster_name,omitempty"`
}

ResponseContext : Context with key properties for problem determination.

type ServiceID 

type ServiceID struct {
	// Context with key properties for problem determination.
	Context *ResponseContext `json:"context,omitempty"`

	// Unique identifier of this Service Id.
	ID *string `json:"id" validate:"required"`

	// Cloud wide identifier for identities of this service ID.
	IamID *string `json:"iam_id" validate:"required"`

	// Version of the service ID details object. You need to specify this value when updating the service ID to avoid stale
	// updates.
	EntityTag *string `json:"entity_tag" validate:"required"`

	// Cloud Resource Name of the item. Example Cloud Resource Name:
	// 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::serviceid:1234-5678-9012'.
	CRN *string `json:"crn" validate:"required"`

	// The service ID cannot be changed if set to true.
	Locked *bool `json:"locked" validate:"required"`

	// If set contains a date time string of the creation date in ISO format.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// If set contains a date time string of the last modification date in ISO format.
	ModifiedAt *strfmt.DateTime `json:"modified_at" validate:"required"`

	// ID of the account the service ID belongs to.
	AccountID *string `json:"account_id" validate:"required"`

	// Name of the Service Id. The name is not checked for uniqueness. Therefore multiple names with the same value can
	// exist. Access is done via the UUID of the Service Id.
	Name *string `json:"name" validate:"required"`

	// The optional description of the Service Id. The 'description' property is only available if a description was
	// provided during a create of a Service Id.
	Description *string `json:"description,omitempty"`

	// Optional list of CRNs (string array) which point to the services connected to the service ID.
	UniqueInstanceCrns []string `json:"unique_instance_crns,omitempty"`

	// History of the Service ID.
	History []EnityHistoryRecord `json:"history,omitempty"`

	// Response body format for API key V1 REST requests.
	Apikey *APIKey `json:"apikey,omitempty"`

	Activity *Activity `json:"activity,omitempty"`
}

ServiceID : Response body format for service ID V1 REST requests.

type ServiceIDList added in v0.17.2 

type ServiceIDList struct {
	// Context with key properties for problem determination.
	Context *ResponseContext `json:"context,omitempty"`

	// The offset of the current page.
	Offset *int64 `json:"offset,omitempty"`

	// Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
	Limit *int64 `json:"limit,omitempty"`

	// Link to the first page.
	First *string `json:"first,omitempty"`

	// Link to the previous available page. If 'previous' property is not part of the response no previous page is
	// available.
	Previous *string `json:"previous,omitempty"`

	// Link to the next available page. If 'next' property is not part of the response no next page is available.
	Next *string `json:"next,omitempty"`

	// List of service IDs based on the query paramters and the page size. The service IDs array is always part of the
	// response but might be empty depending on the query parameter values provided.
	Serviceids []ServiceID `json:"serviceids" validate:"required"`
}

ServiceIDList : Response body format for the list service ID V1 REST request.

type SetProfileIdentitiesOptions added in v0.40.0 

type SetProfileIdentitiesOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

	// Entity tag of the Identities to be updated. Specify the tag that you retrieved when reading the Profile Identities.
	// This value helps identify parallel usage of this API. Pass * to indicate updating any available version, which may
	// result in stale updates.
	IfMatch *string `json:"If-Match" validate:"required"`

	// List of identities that can assume the trusted profile.
	Identities []ProfileIdentityRequest `json:"identities,omitempty"`

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

SetProfileIdentitiesOptions : The SetProfileIdentities options.

func (*SetProfileIdentitiesOptions) SetHeaders added in v0.40.0 

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

SetHeaders : Allow user to set Headers

func (*SetProfileIdentitiesOptions) SetIdentities added in v0.40.0 

func (_options *SetProfileIdentitiesOptions) SetIdentities(identities []ProfileIdentityRequest) *SetProfileIdentitiesOptions

SetIdentities : Allow user to set Identities

func (*SetProfileIdentitiesOptions) SetIfMatch added in v0.40.0 

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

SetIfMatch : Allow user to set IfMatch

func (*SetProfileIdentitiesOptions) SetProfileID added in v0.40.0 

func (_options *SetProfileIdentitiesOptions) SetProfileID(profileID string) *SetProfileIdentitiesOptions

SetProfileID : Allow user to set ProfileID

type SetProfileIdentityOptions added in v0.40.0 

type SetProfileIdentityOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

	// Type of the identity.
	IdentityType *string `json:"identity-type" validate:"required,ne="`

	// Identifier of the identity that can assume the trusted profiles. This can be a user identifier (IAM id), serviceid
	// or crn. Internally it uses account id of the service id for the identifier 'serviceid' and for the identifier 'crn'
	// it uses account id contained in the CRN.
	Identifier *string `json:"identifier" validate:"required"`

	// Type of the identity.
	Type *string `json:"type" validate:"required"`

	// Only valid for the type user. Accounts from which a user can assume the trusted profile.
	Accounts []string `json:"accounts,omitempty"`

	// Description of the identity that can assume the trusted profile. This is optional field for all the types of
	// identities. When this field is not set for the identity type 'serviceid' then the description of the service id is
	// used. Description is recommended for the identity type 'crn' E.g. 'Instance 1234 of IBM Cloud Service project'.
	Description *string `json:"description,omitempty"`

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

SetProfileIdentityOptions : The SetProfileIdentity options.

func (*SetProfileIdentityOptions) SetAccounts added in v0.40.0 

func (_options *SetProfileIdentityOptions) SetAccounts(accounts []string) *SetProfileIdentityOptions

SetAccounts : Allow user to set Accounts

func (*SetProfileIdentityOptions) SetDescription added in v0.40.0 

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

SetDescription : Allow user to set Description

func (*SetProfileIdentityOptions) SetHeaders added in v0.40.0 

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

SetHeaders : Allow user to set Headers

func (*SetProfileIdentityOptions) SetIdentifier added in v0.40.0 

func (_options *SetProfileIdentityOptions) SetIdentifier(identifier string) *SetProfileIdentityOptions

SetIdentifier : Allow user to set Identifier

func (*SetProfileIdentityOptions) SetIdentityType added in v0.40.0 

func (_options *SetProfileIdentityOptions) SetIdentityType(identityType string) *SetProfileIdentityOptions

SetIdentityType : Allow user to set IdentityType

func (*SetProfileIdentityOptions) SetProfileID added in v0.40.0 

func (_options *SetProfileIdentityOptions) SetProfileID(profileID string) *SetProfileIdentityOptions

SetProfileID : Allow user to set ProfileID

func (*SetProfileIdentityOptions) SetType added in v0.40.0 

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

SetType : Allow user to set Type

type TemplateAssignmentListResponse added in v0.42.0 

type TemplateAssignmentListResponse struct {
	// Context with key properties for problem determination.
	Context *ResponseContext `json:"context,omitempty"`

	// The offset of the current page.
	Offset *int64 `json:"offset,omitempty"`

	// Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
	Limit *int64 `json:"limit,omitempty"`

	// Link to the first page.
	First *string `json:"first,omitempty"`

	// Link to the previous available page. If 'previous' property is not part of the response no previous page is
	// available.
	Previous *string `json:"previous,omitempty"`

	// Link to the next available page. If 'next' property is not part of the response no next page is available.
	Next *string `json:"next,omitempty"`

	// List of Assignments based on the query paramters and the page size. The assignments array is always part of the
	// response but might be empty depending on the query parameter values provided.
	Assignments []TemplateAssignmentResponse `json:"assignments" validate:"required"`
}

TemplateAssignmentListResponse : List Response body format for Template Assignments Records.

type TemplateAssignmentResource added in v0.42.0 

type TemplateAssignmentResource struct {
	// Id of the created resource.
	ID *string `json:"id,omitempty"`
}

TemplateAssignmentResource : Body parameters for created resource.

type TemplateAssignmentResourceError added in v0.42.0 

type TemplateAssignmentResourceError struct {
	// Name of the error.
	Name *string `json:"name,omitempty"`

	// Internal error code.
	ErrorCode *string `json:"errorCode,omitempty"`

	// Error message detailing the nature of the error.
	Message *string `json:"message,omitempty"`

	// Internal status code for the error.
	StatusCode *string `json:"statusCode,omitempty"`
}

TemplateAssignmentResourceError : Body parameters for assignment error.

type TemplateAssignmentResponse added in v0.42.0 

type TemplateAssignmentResponse struct {
	// Context with key properties for problem determination.
	Context *ResponseContext `json:"context,omitempty"`

	// Assignment record Id.
	ID *string `json:"id" validate:"required"`

	// Enterprise account Id.
	AccountID *string `json:"account_id" validate:"required"`

	// Template Id.
	TemplateID *string `json:"template_id" validate:"required"`

	// Template version.
	TemplateVersion *int64 `json:"template_version" validate:"required"`

	// Assignment target type.
	TargetType *string `json:"target_type" validate:"required"`

	// Assignment target.
	Target *string `json:"target" validate:"required"`

	// Assignment status.
	Status *string `json:"status" validate:"required"`

	// Status breakdown per target account of IAM resources created or errors encountered in attempting to create those IAM
	// resources. IAM resources are only included in the response providing the assignment is not in progress. IAM
	// resources are also only included when getting a single assignment, and excluded by list APIs.
	Resources []TemplateAssignmentResponseResource `json:"resources,omitempty"`

	// Assignment history.
	History []EnityHistoryRecord `json:"history,omitempty"`

	// Href.
	Href *string `json:"href,omitempty"`

	// Assignment created at.
	CreatedAt *string `json:"created_at" validate:"required"`

	// IAMid of the identity that created the assignment.
	CreatedByID *string `json:"created_by_id" validate:"required"`

	// Assignment modified at.
	LastModifiedAt *string `json:"last_modified_at" validate:"required"`

	// IAMid of the identity that last modified the assignment.
	LastModifiedByID *string `json:"last_modified_by_id" validate:"required"`

	// Entity tag for this assignment record.
	EntityTag *string `json:"entity_tag" validate:"required"`
}

TemplateAssignmentResponse : Response body format for Template Assignment Record.

type TemplateAssignmentResponseResource added in v0.42.0 

type TemplateAssignmentResponseResource struct {
	// Target account where the IAM resource is created.
	Target *string `json:"target" validate:"required"`

	Profile *TemplateAssignmentResponseResourceDetail `json:"profile,omitempty"`

	AccountSettings *TemplateAssignmentResponseResourceDetail `json:"account_settings,omitempty"`

	// Policy resource(s) included only for trusted profile assignments with policy references.
	PolicyTemplateRefs []TemplateAssignmentResponseResourceDetail `json:"policy_template_refs,omitempty"`
}

TemplateAssignmentResponseResource : Overview of resources assignment per target account.

type TemplateAssignmentResponseResourceDetail added in v0.42.0 

type TemplateAssignmentResponseResourceDetail struct {
	// Policy Template Id, only returned for a profile assignment with policy references.
	ID *string `json:"id,omitempty"`

	// Policy version, only returned for a profile assignment with policy references.
	Version *string `json:"version,omitempty"`

	// Body parameters for created resource.
	ResourceCreated *TemplateAssignmentResource `json:"resource_created,omitempty"`

	// Body parameters for assignment error.
	ErrorMessage *TemplateAssignmentResourceError `json:"error_message,omitempty"`

	// Status for the target account's assignment.
	Status *string `json:"status" validate:"required"`
}

TemplateAssignmentResponseResourceDetail : TemplateAssignmentResponseResourceDetail struct

type TemplateProfileComponentRequest added in v0.42.0 

type TemplateProfileComponentRequest struct {
	// Name of the Profile.
	Name *string `json:"name" validate:"required"`

	// Description of the Profile.
	Description *string `json:"description,omitempty"`

	// Rules for the Profile.
	Rules []TrustedProfileTemplateClaimRule `json:"rules,omitempty"`

	// Identities for the Profile.
	Identities []ProfileIdentityRequest `json:"identities,omitempty"`
}

TemplateProfileComponentRequest : Input body parameters for the TemplateProfileComponent.

type TemplateProfileComponentResponse added in v0.42.0 

type TemplateProfileComponentResponse struct {
	// Name of the Profile.
	Name *string `json:"name" validate:"required"`

	// Description of the Profile.
	Description *string `json:"description,omitempty"`

	// Rules for the Profile.
	Rules []TrustedProfileTemplateClaimRule `json:"rules,omitempty"`

	// Identities for the Profile.
	Identities []ProfileIdentityResponse `json:"identities,omitempty"`
}

TemplateProfileComponentResponse : Input body parameters for the TemplateProfileComponent.

type TrustedProfile added in v0.20.0 

type TrustedProfile struct {
	// Context with key properties for problem determination.
	Context *ResponseContext `json:"context,omitempty"`

	// the unique identifier of the trusted profile. Example:'Profile-94497d0d-2ac3-41bf-a993-a49d1b14627c'.
	ID *string `json:"id" validate:"required"`

	// Version of the trusted profile details object. You need to specify this value when updating the trusted profile to
	// avoid stale updates.
	EntityTag *string `json:"entity_tag" validate:"required"`

	// Cloud Resource Name of the item. Example Cloud Resource Name:
	// 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::profile:Profile-94497d0d-2ac3-41bf-a993-a49d1b14627c'.
	CRN *string `json:"crn" validate:"required"`

	// Name of the trusted profile. The name is checked for uniqueness. Therefore trusted profiles with the same names can
	// not exist in the same account.
	Name *string `json:"name" validate:"required"`

	// The optional description of the trusted profile. The 'description' property is only available if a description was
	// provided during a create of a trusted profile.
	Description *string `json:"description,omitempty"`

	// If set contains a date time string of the creation date in ISO format.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// If set contains a date time string of the last modification date in ISO format.
	ModifiedAt *strfmt.DateTime `json:"modified_at,omitempty"`

	// The iam_id of this trusted profile.
	IamID *string `json:"iam_id" validate:"required"`

	// ID of the account that this trusted profile belong to.
	AccountID *string `json:"account_id" validate:"required"`

	// ID of the IAM template that was used to create an enterprise-managed trusted profile in your account. When returned,
	// this indicates that the trusted profile is created from and managed by a template in the root enterprise account.
	TemplateID *string `json:"template_id,omitempty"`

	// ID of the assignment that was used to create an enterprise-managed trusted profile in your account. When returned,
	// this indicates that the trusted profile is created from and managed by a template in the root enterprise account.
	AssignmentID *string `json:"assignment_id,omitempty"`

	// IMS acount ID of the trusted profile.
	ImsAccountID *int64 `json:"ims_account_id,omitempty"`

	// IMS user ID of the trusted profile.
	ImsUserID *int64 `json:"ims_user_id,omitempty"`

	// History of the trusted profile.
	History []EnityHistoryRecord `json:"history,omitempty"`

	Activity *Activity `json:"activity,omitempty"`
}

TrustedProfile : Response body format for trusted profile V1 REST requests.

type TrustedProfileTemplateClaimRule added in v0.42.0 

type TrustedProfileTemplateClaimRule struct {
	// Name of the claim rule to be created or updated.
	Name *string `json:"name,omitempty"`

	// Type of the claim rule.
	Type *string `json:"type" validate:"required"`

	// The realm name of the Idp this claim rule applies to. This field is required only if the type is specified as
	// 'Profile-SAML'.
	RealmName *string `json:"realm_name,omitempty"`

	// Session expiration in seconds, only required if type is 'Profile-SAML'.
	Expiration *int64 `json:"expiration,omitempty"`

	// Conditions of this claim rule.
	Conditions []ProfileClaimRuleConditions `json:"conditions" validate:"required"`
}

TrustedProfileTemplateClaimRule : TrustedProfileTemplateClaimRule struct

type TrustedProfileTemplateList added in v0.42.0 

type TrustedProfileTemplateList struct {
	// Context with key properties for problem determination.
	Context *ResponseContext `json:"context,omitempty"`

	// The offset of the current page.
	Offset *int64 `json:"offset,omitempty"`

	// Optional size of a single page.
	Limit *int64 `json:"limit,omitempty"`

	// Link to the first page.
	First *string `json:"first,omitempty"`

	// Link to the previous available page. If 'previous' property is not part of the response no previous page is
	// available.
	Previous *string `json:"previous,omitempty"`

	// Link to the next available page. If 'next' property is not part of the response no next page is available.
	Next *string `json:"next,omitempty"`

	// List of Profile Templates based on the query paramters and the page size. The profile_templates array is always part
	// of the response but might be empty depending on the query parameter values provided.
	ProfileTemplates []TrustedProfileTemplateResponse `json:"profile_templates" validate:"required"`
}

TrustedProfileTemplateList : TrustedProfileTemplateList struct

type TrustedProfileTemplateResponse added in v0.42.0 

type TrustedProfileTemplateResponse struct {
	// ID of the the template.
	ID *string `json:"id" validate:"required"`

	// Version of the the template.
	Version *int64 `json:"version" validate:"required"`

	// ID of the account where the template resides.
	AccountID *string `json:"account_id" validate:"required"`

	// The name of the trusted profile template. This is visible only in the enterprise account.
	Name *string `json:"name" validate:"required"`

	// The description of the trusted profile template. Describe the template for enterprise account users.
	Description *string `json:"description,omitempty"`

	// Committed flag determines if the template is ready for assignment.
	Committed *bool `json:"committed,omitempty"`

	// Input body parameters for the TemplateProfileComponent.
	Profile *TemplateProfileComponentResponse `json:"profile,omitempty"`

	// Existing policy templates that you can reference to assign access in the trusted profile component.
	PolicyTemplateReferences []PolicyTemplateReference `json:"policy_template_references,omitempty"`

	// History of the trusted profile template.
	History []EnityHistoryRecord `json:"history,omitempty"`

	// Entity tag for this templateId-version combination.
	EntityTag *string `json:"entity_tag,omitempty"`

	// Cloud resource name.
	CRN *string `json:"crn,omitempty"`

	// Timestamp of when the template was created.
	CreatedAt *string `json:"created_at,omitempty"`

	// IAMid of the creator.
	CreatedByID *string `json:"created_by_id,omitempty"`

	// Timestamp of when the template was last modified.
	LastModifiedAt *string `json:"last_modified_at,omitempty"`

	// IAMid of the identity that made the latest modification.
	LastModifiedByID *string `json:"last_modified_by_id,omitempty"`
}

TrustedProfileTemplateResponse : Response body format for Trusted Profile Template REST requests.

type TrustedProfilesList added in v0.20.0 

type TrustedProfilesList struct {
	// Context with key properties for problem determination.
	Context *ResponseContext `json:"context,omitempty"`

	// The offset of the current page.
	Offset *int64 `json:"offset,omitempty"`

	// Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
	Limit *int64 `json:"limit,omitempty"`

	// Link to the first page.
	First *string `json:"first,omitempty"`

	// Link to the previous available page. If 'previous' property is not part of the response no previous page is
	// available.
	Previous *string `json:"previous,omitempty"`

	// Link to the next available page. If 'next' property is not part of the response no next page is available.
	Next *string `json:"next,omitempty"`

	// List of trusted profiles.
	Profiles []TrustedProfile `json:"profiles" validate:"required"`
}

TrustedProfilesList : Response body format for the List trusted profiles V1 REST request.

type UnlockAPIKeyOptions added in v0.17.2 

type UnlockAPIKeyOptions struct {
	// Unique ID of the API key.
	ID *string `json:"id" validate:"required,ne="`

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

UnlockAPIKeyOptions : The UnlockAPIKey options.

func (*UnlockAPIKeyOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*UnlockAPIKeyOptions) SetID added in v0.17.2 

func (_options *UnlockAPIKeyOptions) SetID(id string) *UnlockAPIKeyOptions

SetID : Allow user to set ID

type UnlockServiceIDOptions added in v0.17.2 

type UnlockServiceIDOptions struct {
	// Unique ID of the service ID.
	ID *string `json:"id" validate:"required,ne="`

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

UnlockServiceIDOptions : The UnlockServiceID options.

func (*UnlockServiceIDOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*UnlockServiceIDOptions) SetID added in v0.17.2 

func (_options *UnlockServiceIDOptions) SetID(id string) *UnlockServiceIDOptions

SetID : Allow user to set ID

type UpdateAPIKeyOptions added in v0.17.2 

type UpdateAPIKeyOptions struct {
	// Unique ID of the API key to be updated.
	ID *string `json:"id" validate:"required,ne="`

	// Version of the API key to be updated. Specify the version that you retrieved when reading the API key. 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"`

	// The name of the API key to update. If specified in the request the parameter must not be empty. The name is not
	// checked for uniqueness. Failure to this will result in an Error condition.
	Name *string `json:"name,omitempty"`

	// The description of the API key to update. If specified an empty description will clear the description of the API
	// key. If a non empty value is provided the API key will be updated.
	Description *string `json:"description,omitempty"`

	// Defines if the API key supports sessions. Sessions are only supported for user apikeys.
	SupportSessions *bool `json:"support_sessions,omitempty"`

	// Defines the action to take when API key is leaked, valid values are 'none', 'disable' and 'delete'.
	ActionWhenLeaked *string `json:"action_when_leaked,omitempty"`

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

UpdateAPIKeyOptions : The UpdateAPIKey options.

func (*UpdateAPIKeyOptions) SetActionWhenLeaked added in v0.62.0 

func (_options *UpdateAPIKeyOptions) SetActionWhenLeaked(actionWhenLeaked string) *UpdateAPIKeyOptions

SetActionWhenLeaked : Allow user to set ActionWhenLeaked

func (*UpdateAPIKeyOptions) SetDescription added in v0.17.2 

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

SetDescription : Allow user to set Description

func (*UpdateAPIKeyOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*UpdateAPIKeyOptions) SetID added in v0.17.2 

func (_options *UpdateAPIKeyOptions) SetID(id string) *UpdateAPIKeyOptions

SetID : Allow user to set ID

func (*UpdateAPIKeyOptions) SetIfMatch added in v0.17.2 

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

SetIfMatch : Allow user to set IfMatch

func (*UpdateAPIKeyOptions) SetName added in v0.17.2 

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

SetName : Allow user to set Name

func (*UpdateAPIKeyOptions) SetSupportSessions added in v0.62.0 

func (_options *UpdateAPIKeyOptions) SetSupportSessions(supportSessions bool) *UpdateAPIKeyOptions

SetSupportSessions : Allow user to set SupportSessions

type UpdateAccountSettingsAssignmentOptions added in v0.42.0 

type UpdateAccountSettingsAssignmentOptions 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 to be applied to the assignment. To retry all failed assignments, provide the existing version. To
	// migrate to a different version, provide the new version number.
	TemplateVersion *int64 `json:"template_version" validate:"required"`

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

UpdateAccountSettingsAssignmentOptions : The UpdateAccountSettingsAssignment options.

func (*UpdateAccountSettingsAssignmentOptions) SetAssignmentID added in v0.42.0 

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

SetAssignmentID : Allow user to set AssignmentID

func (*UpdateAccountSettingsAssignmentOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*UpdateAccountSettingsAssignmentOptions) SetIfMatch added in v0.42.0 

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

SetIfMatch : Allow user to set IfMatch

func (*UpdateAccountSettingsAssignmentOptions) SetTemplateVersion added in v0.42.0 

func (_options *UpdateAccountSettingsAssignmentOptions) SetTemplateVersion(templateVersion int64) *UpdateAccountSettingsAssignmentOptions

SetTemplateVersion : Allow user to set TemplateVersion

type UpdateAccountSettingsOptions added in v0.17.17 

type UpdateAccountSettingsOptions struct {
	// Version of the account settings to be updated. Specify the version that you retrieved as entity_tag (ETag header)
	// when reading the account. 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"`

	// The id of the account to update the settings for.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// Defines whether or not creating a service ID is access controlled. Valid values:
	//   * RESTRICTED - only users assigned the 'Service ID creator' role on the IAM Identity Service can create service
	// IDs, including the account owner
	//   * NOT_RESTRICTED - all members of an account can create service IDs
	//   * NOT_SET - to 'unset' a previous set value.
	RestrictCreateServiceID *string `json:"restrict_create_service_id,omitempty"`

	// Defines whether or not creating platform API keys is access controlled. Valid values:
	//   * RESTRICTED - only users assigned the 'User API key creator' role on the IAM Identity Service can create API
	// keys, including the account owner
	//   * NOT_RESTRICTED - all members of an account can create platform API keys
	//   * NOT_SET - to 'unset' a previous set value.
	RestrictCreatePlatformApikey *string `json:"restrict_create_platform_apikey,omitempty"`

	// Defines the IP addresses and subnets from which IAM tokens can be created for the account.
	AllowedIPAddresses *string `json:"allowed_ip_addresses,omitempty"`

	// Defines the MFA trait for the account. Valid values:
	//   * NONE - No MFA trait set
	//   * NONE_NO_ROPC- No MFA, disable CLI logins with only a password
	//   * TOTP - For all non-federated IBMId users
	//   * TOTP4ALL - For all users
	//   * LEVEL1 - Email-based MFA for all users
	//   * LEVEL2 - TOTP-based MFA for all users
	//   * LEVEL3 - U2F MFA for all users.
	Mfa *string `json:"mfa,omitempty"`

	// List of users that are exempted from the MFA requirement of the account.
	UserMfa []AccountSettingsUserMfa `json:"user_mfa,omitempty"`

	// Defines the session expiration in seconds for the account. Valid values:
	//   * Any whole number between between '900' and '86400'
	//   * NOT_SET - To unset account setting and use service default.
	SessionExpirationInSeconds *string `json:"session_expiration_in_seconds,omitempty"`

	// Defines the period of time in seconds in which a session will be invalidated due to inactivity. Valid values:
	//   * Any whole number between '900' and '7200'
	//   * NOT_SET - To unset account setting and use service default.
	SessionInvalidationInSeconds *string `json:"session_invalidation_in_seconds,omitempty"`

	// Defines the max allowed sessions per identity required by the account. Value values:
	//   * Any whole number greater than 0
	//   * NOT_SET - To unset account setting and use service default.
	MaxSessionsPerIdentity *string `json:"max_sessions_per_identity,omitempty"`

	// Defines the access token expiration in seconds. Valid values:
	//   * Any whole number between '900' and '3600'
	//   * NOT_SET - To unset account setting and use service default.
	SystemAccessTokenExpirationInSeconds *string `json:"system_access_token_expiration_in_seconds,omitempty"`

	// Defines the refresh token expiration in seconds. Valid values:
	//   * Any whole number between '900' and '259200'
	//   * NOT_SET - To unset account setting and use service default.
	SystemRefreshTokenExpirationInSeconds *string `json:"system_refresh_token_expiration_in_seconds,omitempty"`

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

UpdateAccountSettingsOptions : The UpdateAccountSettings options.

func (*UpdateAccountSettingsOptions) SetAccountID added in v0.17.17 

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

SetAccountID : Allow user to set AccountID

func (*UpdateAccountSettingsOptions) SetAllowedIPAddresses added in v0.17.17 

func (_options *UpdateAccountSettingsOptions) SetAllowedIPAddresses(allowedIPAddresses string) *UpdateAccountSettingsOptions

SetAllowedIPAddresses : Allow user to set AllowedIPAddresses

func (*UpdateAccountSettingsOptions) SetHeaders added in v0.17.17 

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

SetHeaders : Allow user to set Headers

func (*UpdateAccountSettingsOptions) SetIfMatch added in v0.17.17 

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

SetIfMatch : Allow user to set IfMatch

func (*UpdateAccountSettingsOptions) SetMaxSessionsPerIdentity added in v0.18.10 

func (_options *UpdateAccountSettingsOptions) SetMaxSessionsPerIdentity(maxSessionsPerIdentity string) *UpdateAccountSettingsOptions

SetMaxSessionsPerIdentity : Allow user to set MaxSessionsPerIdentity

func (*UpdateAccountSettingsOptions) SetMfa added in v0.17.17 

func (_options *UpdateAccountSettingsOptions) SetMfa(mfa string) *UpdateAccountSettingsOptions

SetMfa : Allow user to set Mfa

func (*UpdateAccountSettingsOptions) SetRestrictCreatePlatformApikey added in v0.17.17 

func (_options *UpdateAccountSettingsOptions) SetRestrictCreatePlatformApikey(restrictCreatePlatformApikey string) *UpdateAccountSettingsOptions

SetRestrictCreatePlatformApikey : Allow user to set RestrictCreatePlatformApikey

func (*UpdateAccountSettingsOptions) SetRestrictCreateServiceID added in v0.17.17 

func (_options *UpdateAccountSettingsOptions) SetRestrictCreateServiceID(restrictCreateServiceID string) *UpdateAccountSettingsOptions

SetRestrictCreateServiceID : Allow user to set RestrictCreateServiceID

func (*UpdateAccountSettingsOptions) SetSessionExpirationInSeconds added in v0.17.17 

func (_options *UpdateAccountSettingsOptions) SetSessionExpirationInSeconds(sessionExpirationInSeconds string) *UpdateAccountSettingsOptions

SetSessionExpirationInSeconds : Allow user to set SessionExpirationInSeconds

func (*UpdateAccountSettingsOptions) SetSessionInvalidationInSeconds added in v0.17.17 

func (_options *UpdateAccountSettingsOptions) SetSessionInvalidationInSeconds(sessionInvalidationInSeconds string) *UpdateAccountSettingsOptions

SetSessionInvalidationInSeconds : Allow user to set SessionInvalidationInSeconds

func (*UpdateAccountSettingsOptions) SetSystemAccessTokenExpirationInSeconds added in v0.31.0 

func (_options *UpdateAccountSettingsOptions) SetSystemAccessTokenExpirationInSeconds(systemAccessTokenExpirationInSeconds string) *UpdateAccountSettingsOptions

SetSystemAccessTokenExpirationInSeconds : Allow user to set SystemAccessTokenExpirationInSeconds

func (*UpdateAccountSettingsOptions) SetSystemRefreshTokenExpirationInSeconds added in v0.31.0 

func (_options *UpdateAccountSettingsOptions) SetSystemRefreshTokenExpirationInSeconds(systemRefreshTokenExpirationInSeconds string) *UpdateAccountSettingsOptions

SetSystemRefreshTokenExpirationInSeconds : Allow user to set SystemRefreshTokenExpirationInSeconds

func (*UpdateAccountSettingsOptions) SetUserMfa added in v0.31.0 

func (_options *UpdateAccountSettingsOptions) SetUserMfa(userMfa []AccountSettingsUserMfa) *UpdateAccountSettingsOptions

SetUserMfa : Allow user to set UserMfa

type UpdateAccountSettingsTemplateVersionOptions added in v0.42.0 

type UpdateAccountSettingsTemplateVersionOptions struct {
	// Entity tag of the Template to be updated. Specify the tag that you retrieved when reading the account settings
	// template. 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"`

	// ID of the account settings template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// Version of the account settings template.
	Version *string `json:"version" validate:"required,ne="`

	// ID of the account where the template resides.
	AccountID *string `json:"account_id,omitempty"`

	// The name of the trusted profile template. This is visible only in the enterprise account.
	Name *string `json:"name,omitempty"`

	// The description of the trusted profile template. Describe the template for enterprise account users.
	Description *string `json:"description,omitempty"`

	AccountSettings *AccountSettingsComponent `json:"account_settings,omitempty"`

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

UpdateAccountSettingsTemplateVersionOptions : The UpdateAccountSettingsTemplateVersion options.

func (*UpdateAccountSettingsTemplateVersionOptions) SetAccountID added in v0.42.0 

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

SetAccountID : Allow user to set AccountID

func (*UpdateAccountSettingsTemplateVersionOptions) SetAccountSettings added in v0.42.0 

func (_options *UpdateAccountSettingsTemplateVersionOptions) SetAccountSettings(accountSettings *AccountSettingsComponent) *UpdateAccountSettingsTemplateVersionOptions

SetAccountSettings : Allow user to set AccountSettings

func (*UpdateAccountSettingsTemplateVersionOptions) SetDescription added in v0.42.0 

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

SetDescription : Allow user to set Description

func (*UpdateAccountSettingsTemplateVersionOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*UpdateAccountSettingsTemplateVersionOptions) SetIfMatch added in v0.42.0 

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

SetIfMatch : Allow user to set IfMatch

func (*UpdateAccountSettingsTemplateVersionOptions) SetName added in v0.42.0 

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

SetName : Allow user to set Name

func (*UpdateAccountSettingsTemplateVersionOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

func (*UpdateAccountSettingsTemplateVersionOptions) SetVersion added in v0.42.0 

func (_options *UpdateAccountSettingsTemplateVersionOptions) SetVersion(version string) *UpdateAccountSettingsTemplateVersionOptions

SetVersion : Allow user to set Version

type UpdateClaimRuleOptions added in v0.20.0 

type UpdateClaimRuleOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

	// ID of the claim rule to update.
	RuleID *string `json:"rule-id" validate:"required,ne="`

	// Version of the claim rule to be updated. Specify the version that you retrived when reading list of claim rules.
	// This value helps to identify any parallel usage of claim rule. Pass * to indicate to update any version available.
	// This might result in stale updates.
	IfMatch *string `json:"If-Match" validate:"required"`

	// Type of the claim rule, either 'Profile-SAML' or 'Profile-CR'.
	Type *string `json:"type" validate:"required"`

	// Conditions of this claim rule.
	Conditions []ProfileClaimRuleConditions `json:"conditions" validate:"required"`

	// Context with key properties for problem determination.
	Context *ResponseContext `json:"context,omitempty"`

	// Name of the claim rule to be created or updated.
	Name *string `json:"name,omitempty"`

	// The realm name of the Idp this claim rule applies to. This field is required only if the type is specified as
	// 'Profile-SAML'.
	RealmName *string `json:"realm_name,omitempty"`

	// The compute resource type the rule applies to, required only if type is specified as 'Profile-CR'. Valid values are
	// VSI, IKS_SA, ROKS_SA.
	CrType *string `json:"cr_type,omitempty"`

	// Session expiration in seconds, only required if type is 'Profile-SAML'.
	Expiration *int64 `json:"expiration,omitempty"`

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

UpdateClaimRuleOptions : The UpdateClaimRule options.

func (*UpdateClaimRuleOptions) SetConditions added in v0.20.0 

func (_options *UpdateClaimRuleOptions) SetConditions(conditions []ProfileClaimRuleConditions) *UpdateClaimRuleOptions

SetConditions : Allow user to set Conditions

func (*UpdateClaimRuleOptions) SetContext added in v0.20.0 

func (_options *UpdateClaimRuleOptions) SetContext(context *ResponseContext) *UpdateClaimRuleOptions

SetContext : Allow user to set Context

func (*UpdateClaimRuleOptions) SetCrType added in v0.20.0 

func (_options *UpdateClaimRuleOptions) SetCrType(crType string) *UpdateClaimRuleOptions

SetCrType : Allow user to set CrType

func (*UpdateClaimRuleOptions) SetExpiration added in v0.20.0 

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

SetExpiration : Allow user to set Expiration

func (*UpdateClaimRuleOptions) SetHeaders added in v0.20.0 

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

SetHeaders : Allow user to set Headers

func (*UpdateClaimRuleOptions) SetIfMatch added in v0.20.0 

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

SetIfMatch : Allow user to set IfMatch

func (*UpdateClaimRuleOptions) SetName added in v0.20.0 

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

SetName : Allow user to set Name

func (*UpdateClaimRuleOptions) SetProfileID added in v0.20.0 

func (_options *UpdateClaimRuleOptions) SetProfileID(profileID string) *UpdateClaimRuleOptions

SetProfileID : Allow user to set ProfileID

func (*UpdateClaimRuleOptions) SetRealmName added in v0.20.0 

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

SetRealmName : Allow user to set RealmName

func (*UpdateClaimRuleOptions) SetRuleID added in v0.20.0 

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

SetRuleID : Allow user to set RuleID

func (*UpdateClaimRuleOptions) SetType added in v0.20.0 

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

SetType : Allow user to set Type

type UpdateProfileOptions added in v0.20.0 

type UpdateProfileOptions struct {
	// ID of the trusted profile to be updated.
	ProfileID *string `json:"profile-id" validate:"required,ne="`

	// Version of the trusted profile to be updated. Specify the version that you retrived when reading list of trusted
	// profiles. This value helps to identify any parallel usage of trusted profile. Pass * to indicate to update any
	// version available. This might result in stale updates.
	IfMatch *string `json:"If-Match" validate:"required"`

	// The name of the trusted profile to update. If specified in the request the parameter must not be empty. The name is
	// checked for uniqueness. Failure to this will result in an Error condition.
	Name *string `json:"name,omitempty"`

	// The description of the trusted profile to update. If specified an empty description will clear the description of
	// the trusted profile. If a non empty value is provided the trusted profile will be updated.
	Description *string `json:"description,omitempty"`

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

UpdateProfileOptions : The UpdateProfile options.

func (*UpdateProfileOptions) SetDescription added in v0.20.0 

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

SetDescription : Allow user to set Description

func (*UpdateProfileOptions) SetHeaders added in v0.20.0 

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

SetHeaders : Allow user to set Headers

func (*UpdateProfileOptions) SetIfMatch added in v0.20.0 

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

SetIfMatch : Allow user to set IfMatch

func (*UpdateProfileOptions) SetName added in v0.20.0 

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

SetName : Allow user to set Name

func (*UpdateProfileOptions) SetProfileID added in v0.20.0 

func (_options *UpdateProfileOptions) SetProfileID(profileID string) *UpdateProfileOptions

SetProfileID : Allow user to set ProfileID

type UpdateProfileTemplateVersionOptions added in v0.42.0 

type UpdateProfileTemplateVersionOptions struct {
	// Entity tag of the Template to be updated. Specify the tag that you retrieved when reading the Profile Template. 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"`

	// ID of the trusted profile template.
	TemplateID *string `json:"template_id" validate:"required,ne="`

	// Version of the Profile Template.
	Version *string `json:"version" validate:"required,ne="`

	// ID of the account where the template resides.
	AccountID *string `json:"account_id,omitempty"`

	// The name of the trusted profile template. This is visible only in the enterprise account. Required field when
	// creating a new template. Otherwise this field is optional. If the field is included it will change the name value
	// for all existing versions of the template.
	Name *string `json:"name,omitempty"`

	// The description of the trusted profile template. Describe the template for enterprise account users.
	Description *string `json:"description,omitempty"`

	// Input body parameters for the TemplateProfileComponent.
	Profile *TemplateProfileComponentRequest `json:"profile,omitempty"`

	// Existing policy templates that you can reference to assign access in the trusted profile component.
	PolicyTemplateReferences []PolicyTemplateReference `json:"policy_template_references,omitempty"`

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

UpdateProfileTemplateVersionOptions : The UpdateProfileTemplateVersion options.

func (*UpdateProfileTemplateVersionOptions) SetAccountID added in v0.42.0 

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

SetAccountID : Allow user to set AccountID

func (*UpdateProfileTemplateVersionOptions) SetDescription added in v0.42.0 

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

SetDescription : Allow user to set Description

func (*UpdateProfileTemplateVersionOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*UpdateProfileTemplateVersionOptions) SetIfMatch added in v0.42.0 

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

SetIfMatch : Allow user to set IfMatch

func (*UpdateProfileTemplateVersionOptions) SetName added in v0.42.0 

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

SetName : Allow user to set Name

func (*UpdateProfileTemplateVersionOptions) SetPolicyTemplateReferences added in v0.42.0 

func (_options *UpdateProfileTemplateVersionOptions) SetPolicyTemplateReferences(policyTemplateReferences []PolicyTemplateReference) *UpdateProfileTemplateVersionOptions

SetPolicyTemplateReferences : Allow user to set PolicyTemplateReferences

func (*UpdateProfileTemplateVersionOptions) SetProfile added in v0.42.0 

func (_options *UpdateProfileTemplateVersionOptions) SetProfile(profile *TemplateProfileComponentRequest) *UpdateProfileTemplateVersionOptions

SetProfile : Allow user to set Profile

func (*UpdateProfileTemplateVersionOptions) SetTemplateID added in v0.42.0 

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

SetTemplateID : Allow user to set TemplateID

func (*UpdateProfileTemplateVersionOptions) SetVersion added in v0.42.0 

func (_options *UpdateProfileTemplateVersionOptions) SetVersion(version string) *UpdateProfileTemplateVersionOptions

SetVersion : Allow user to set Version

type UpdateServiceIDOptions added in v0.17.2 

type UpdateServiceIDOptions struct {
	// Unique ID of the service ID to be updated.
	ID *string `json:"id" validate:"required,ne="`

	// Version of the service ID to be updated. Specify the version that you retrieved as entity_tag (ETag header) when
	// reading the service ID. 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"`

	// The name of the service ID to update. If specified in the request the parameter must not be empty. The name is not
	// checked for uniqueness. Failure to this will result in an Error condition.
	Name *string `json:"name,omitempty"`

	// The description of the service ID to update. If specified an empty description will clear the description of the
	// service ID. If an non empty value is provided the service ID will be updated.
	Description *string `json:"description,omitempty"`

	// List of CRNs which point to the services connected to this service ID. If specified an empty list will clear all
	// existing unique instance crns of the service ID.
	UniqueInstanceCrns []string `json:"unique_instance_crns,omitempty"`

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

UpdateServiceIDOptions : The UpdateServiceID options.

func (*UpdateServiceIDOptions) SetDescription added in v0.17.2 

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

SetDescription : Allow user to set Description

func (*UpdateServiceIDOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*UpdateServiceIDOptions) SetID added in v0.17.2 

func (_options *UpdateServiceIDOptions) SetID(id string) *UpdateServiceIDOptions

SetID : Allow user to set ID

func (*UpdateServiceIDOptions) SetIfMatch added in v0.17.2 

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

SetIfMatch : Allow user to set IfMatch

func (*UpdateServiceIDOptions) SetName added in v0.17.2 

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

SetName : Allow user to set Name

func (*UpdateServiceIDOptions) SetUniqueInstanceCrns added in v0.17.2 

func (_options *UpdateServiceIDOptions) SetUniqueInstanceCrns(uniqueInstanceCrns []string) *UpdateServiceIDOptions

SetUniqueInstanceCrns : Allow user to set UniqueInstanceCrns

type UpdateTrustedProfileAssignmentOptions added in v0.42.0 

type UpdateTrustedProfileAssignmentOptions 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 to be applied to the assignment. To retry all failed assignments, provide the existing version. To
	// migrate to a different version, provide the new version number.
	TemplateVersion *int64 `json:"template_version" validate:"required"`

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

UpdateTrustedProfileAssignmentOptions : The UpdateTrustedProfileAssignment options.

func (*UpdateTrustedProfileAssignmentOptions) SetAssignmentID added in v0.42.0 

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

SetAssignmentID : Allow user to set AssignmentID

func (*UpdateTrustedProfileAssignmentOptions) SetHeaders added in v0.42.0 

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

SetHeaders : Allow user to set Headers

func (*UpdateTrustedProfileAssignmentOptions) SetIfMatch added in v0.42.0 

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

SetIfMatch : Allow user to set IfMatch

func (*UpdateTrustedProfileAssignmentOptions) SetTemplateVersion added in v0.42.0 

func (_options *UpdateTrustedProfileAssignmentOptions) SetTemplateVersion(templateVersion int64) *UpdateTrustedProfileAssignmentOptions

SetTemplateVersion : Allow user to set TemplateVersion

type UserActivity added in v0.24.0 

type UserActivity struct {
	// IAMid of the user.
	IamID *string `json:"iam_id" validate:"required"`

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

	// Username of the user.
	Username *string `json:"username" validate:"required"`

	// Email of the user.
	Email *string `json:"email,omitempty"`

	// Time when the user was last authenticated.
	LastAuthn *string `json:"last_authn,omitempty"`
}

UserActivity : UserActivity struct

type UserMfaEnrollments added in v0.31.6 

type UserMfaEnrollments struct {
	// IAMid of the user.
	IamID *string `json:"iam_id" validate:"required"`

	// currently effective mfa type i.e. id_based_mfa or account_based_mfa.
	EffectiveMfaType *string `json:"effective_mfa_type,omitempty"`

	IDBasedMfa *IDBasedMfaEnrollment `json:"id_based_mfa,omitempty"`

	AccountBasedMfa *AccountBasedMfaEnrollment `json:"account_based_mfa,omitempty"`
}

UserMfaEnrollments : UserMfaEnrollments struct

type UserReportMfaEnrollmentStatus added in v0.31.6 

type UserReportMfaEnrollmentStatus struct {
	// IAMid of the user.
	IamID *string `json:"iam_id" validate:"required"`

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

	// Username of the user.
	Username *string `json:"username" validate:"required"`

	// Email of the user.
	Email *string `json:"email,omitempty"`

	Enrollments *MfaEnrollments `json:"enrollments" validate:"required"`
}

UserReportMfaEnrollmentStatus : UserReportMfaEnrollmentStatus struct

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.