iamidentityv1

package
v0.22.2 Latest Latest
Warning

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

 Go to latest Published: Oct 27, 2021 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 (
	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 - to apply access control
  • NOT_RESTRICTED - to remove access control
  • 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"
	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
  • 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 (
	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 (
	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 (
	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 - to apply access control
  • NOT_RESTRICTED - to remove access control
  • NOT_SET - to unset a previously 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 - to apply access control
  • NOT_RESTRICTED - to remove access control
  • NOT_SET - to 'unset' a previous set value.
View Source 
const (
	UpdateAccountSettingsOptionsMfaLevel1Const   = "LEVEL1"
	UpdateAccountSettingsOptionsMfaLevel2Const   = "LEVEL2"
	UpdateAccountSettingsOptionsMfaLevel3Const   = "LEVEL3"
	UpdateAccountSettingsOptionsMfaNoneConst     = "NONE"
	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
  • 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.

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

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

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

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

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, NO validation of that apiKey value is
	// done, i.e. the value can be non-URL safe. 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. Please 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 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 - to apply access control
	//   * NOT_RESTRICTED - to remove access control
	//   * 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
	//   * 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"`

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

AccountSettingsResponse : Response body format for Account Settings REST requests.

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, NO validation of that apiKey value is
	// done, i.e. the value can be non-URL safe. 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. Please 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"`

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

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

type CreateClaimRuleOptions added in v0.20.0 

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

	// Type of the calim 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:"-" 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 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 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:"-"`

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

type DeleteAPIKeyOptions struct {
	// Unique ID of the API key.
	ID *string `json:"-" 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 DeleteClaimRuleOptions added in v0.20.0 

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

	// ID of the claim rule to delete.
	RuleID *string `json:"-" 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:"-" validate:"required,ne="`

	// ID of the link.
	LinkID *string `json:"-" 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 DeleteProfileOptions added in v0.20.0 

type DeleteProfileOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"-" 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 DeleteServiceIDOptions added in v0.17.2 

type DeleteServiceIDOptions struct {
	// Unique ID of the service ID.
	ID *string `json:"-" 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 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 GetAPIKeyOptions added in v0.17.2 

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

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

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

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

	// 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 GetAccountSettingsOptions added in v0.17.17 

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

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

	// 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 GetClaimRuleOptions added in v0.20.0 

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

	// ID of the claim rule to get.
	RuleID *string `json:"-" 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 GetLinkOptions added in v0.20.0 

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

	// ID of the link.
	LinkID *string `json:"-" 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 GetProfileOptions added in v0.20.0 

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

	// 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) SetProfileID added in v0.20.0 

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

SetProfileID : Allow user to set ProfileID

type GetServiceIDOptions added in v0.17.2 

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

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

	// 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) SetIncludeHistory added in v0.17.2 

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

SetIncludeHistory : Allow user to set IncludeHistory

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

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) 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) 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) 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) 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) 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) 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) 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) 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) DisableRetries added in v0.12.2 

func (iamIdentity *IamIdentityV1) DisableRetries()

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

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) 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 (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) 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) 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) 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 apikey.

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

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

func (*IamIdentityV1) NewCreateAPIKeyOptions(name string, iamID string) *CreateAPIKeyOptions

NewCreateAPIKeyOptions : Instantiate CreateAPIKeyOptions

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

func (*IamIdentityV1) NewCreateServiceIDOptions(accountID string, name string) *CreateServiceIDOptions

NewCreateServiceIDOptions : Instantiate CreateServiceIDOptions

func (*IamIdentityV1) NewDeleteAPIKeyOptions added in v0.17.2 

func (*IamIdentityV1) NewDeleteAPIKeyOptions(id string) *DeleteAPIKeyOptions

NewDeleteAPIKeyOptions : Instantiate DeleteAPIKeyOptions

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) NewDeleteProfileOptions added in v0.20.0 

func (*IamIdentityV1) NewDeleteProfileOptions(profileID string) *DeleteProfileOptions

NewDeleteProfileOptions : Instantiate DeleteProfileOptions

func (*IamIdentityV1) NewDeleteServiceIDOptions added in v0.17.2 

func (*IamIdentityV1) NewDeleteServiceIDOptions(id string) *DeleteServiceIDOptions

NewDeleteServiceIDOptions : Instantiate DeleteServiceIDOptions

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) NewGetAccountSettingsOptions added in v0.17.17 

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

NewGetAccountSettingsOptions : Instantiate GetAccountSettingsOptions

func (*IamIdentityV1) NewGetClaimRuleOptions added in v0.20.0 

func (*IamIdentityV1) NewGetClaimRuleOptions(profileID string, ruleID string) *GetClaimRuleOptions

NewGetClaimRuleOptions : Instantiate GetClaimRuleOptions

func (*IamIdentityV1) NewGetLinkOptions added in v0.20.0 

func (*IamIdentityV1) NewGetLinkOptions(profileID string, linkID string) *GetLinkOptions

NewGetLinkOptions : Instantiate GetLinkOptions

func (*IamIdentityV1) NewGetProfileOptions added in v0.20.0 

func (*IamIdentityV1) NewGetProfileOptions(profileID string) *GetProfileOptions

NewGetProfileOptions : Instantiate GetProfileOptions

func (*IamIdentityV1) NewGetServiceIDOptions added in v0.17.2 

func (*IamIdentityV1) NewGetServiceIDOptions(id string) *GetServiceIDOptions

NewGetServiceIDOptions : Instantiate GetServiceIDOptions

func (*IamIdentityV1) NewListAPIKeysOptions added in v0.17.2 

func (*IamIdentityV1) NewListAPIKeysOptions() *ListAPIKeysOptions

NewListAPIKeysOptions : Instantiate ListAPIKeysOptions

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) 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) 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) 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) 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) NewUpdateAccountSettingsOptions added in v0.17.17 

func (*IamIdentityV1) NewUpdateAccountSettingsOptions(ifMatch string, accountID string) *UpdateAccountSettingsOptions

NewUpdateAccountSettingsOptions : Instantiate UpdateAccountSettingsOptions

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

func (*IamIdentityV1) NewUpdateServiceIDOptions(id string, ifMatch string) *UpdateServiceIDOptions

NewUpdateServiceIDOptions : Instantiate UpdateServiceIDOptions

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) 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, session lifetimes, access control for creating new identities, and enforcing IP restrictions on token creation.

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

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(s) to query. If a service IAM ID is specified in iam_id then account_id must match the
	// account of the IAM ID. If a user IAM ID is specified in iam_id then then account_id must match the account of the
	// Authorization token.
	AccountID *string `json:"-"`

	// IAM ID of the API key(s) 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:"-"`

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

	// Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
	Pagetoken *string `json:"-"`

	// Optional parameter to define the scope of the queried API Keys. Can be 'entity' (default) or 'account'.
	Scope *string `json:"-"`

	// Optional parameter to filter the type of the queried API Keys. Can be 'user' or 'serviceid'.
	Type *string `json:"-"`

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

	// Optional sort order, valid values are asc and desc. Default: asc.
	Order *string `json:"-"`

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

	// 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 ListClaimRulesOptions added in v0.20.0 

type ListClaimRulesOptions struct {
	// ID of the trusted profile.
	ProfileID *string `json:"-" 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:"-" 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 ListProfilesOptions added in v0.20.1 

type ListProfilesOptions struct {
	// Account ID to query for trusted profiles.
	AccountID *string `json:"-" validate:"required"`

	// Name of the trusted profile to query.
	Name *string `json:"-"`

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

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

	// Optional sort order, valid values are asc and desc. Default: asc.
	Order *string `json:"-"`

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

	// Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
	Pagetoken *string `json:"-"`

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

	// Name of the service ID(s) to query. Optional.20 items per page. Valid range is 1 to 100.
	Name *string `json:"-"`

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

	// Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
	Pagetoken *string `json:"-"`

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

	// Optional sort order, valid values are asc and desc. Default: asc.
	Order *string `json:"-"`

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

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

type LockAPIKeyOptions struct {
	// Unique ID of the API key.
	ID *string `json:"-" 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:"-" 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 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 Calim 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.
	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 ProfileLink 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" 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 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"`
}

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

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

TrustedProfile : Response body format for trusted profile V1 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:"-" 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:"-" 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:"-" 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:"-" 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"`

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

UpdateAPIKeyOptions : The UpdateAPIKey options.

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

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:"-" validate:"required"`

	// The id of the account to update the settings for.
	AccountID *string `json:"-" validate:"required,ne="`

	// Defines whether or not creating a Service Id is access controlled. Valid values:
	//   * RESTRICTED - to apply access control
	//   * NOT_RESTRICTED - to remove access control
	//   * NOT_SET - to unset a previously 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
	//   * 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"`

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

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

type UpdateClaimRuleOptions added in v0.20.0 

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

	// ID of the claim rule to update.
	RuleID *string `json:"-" 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:"-" validate:"required"`

	// Type of the calim 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:"-" 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:"-" 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 UpdateServiceIDOptions added in v0.17.2 

type UpdateServiceIDOptions struct {
	// Unique ID of the service ID to be updated.
	ID *string `json:"-" 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:"-" 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

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.