iamidentityv1

package
v0.17.2 Latest Latest
Warning

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

 Go to latest Published: Dec 11, 2020 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 (
	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 (
	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 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 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 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.

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 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:"Entity-Lock,omitempty"`

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

CreateAPIKeyOptions : The CreateAPIKey options.

func (*CreateAPIKeyOptions) SetAccountID added in v0.17.2 

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

SetAccountID : Allow user to set AccountID

func (*CreateAPIKeyOptions) 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 CreateServiceIDOptions added in v0.17.2 

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

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

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

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

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

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

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

CreateServiceIDOptions : The CreateServiceID options.

func (*CreateServiceIDOptions) SetAccountID added in v0.17.2 

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

SetAccountID : Allow user to set AccountID

func (*CreateServiceIDOptions) SetApikey added in v0.17.2 

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

SetApikey : Allow user to set Apikey

func (*CreateServiceIDOptions) SetDescription added in v0.17.2 

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

SetDescription : Allow user to set Description

func (*CreateServiceIDOptions) SetEntityLock added in v0.17.2 

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

SetEntityLock : Allow user to set EntityLock

func (*CreateServiceIDOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*CreateServiceIDOptions) SetName added in v0.17.2 

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

SetName : Allow user to set Name

func (*CreateServiceIDOptions) SetUniqueInstanceCrns added in v0.17.2 

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

SetUniqueInstanceCrns : Allow user to set UniqueInstanceCrns

type DeleteAPIKeyOptions added in v0.17.2 

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

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

DeleteAPIKeyOptions : The DeleteAPIKey options.

func (*DeleteAPIKeyOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*DeleteAPIKeyOptions) SetID added in v0.17.2 

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

SetID : Allow user to set ID

type DeleteServiceIDOptions added in v0.17.2 

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

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

DeleteServiceIDOptions : The DeleteServiceID options.

func (*DeleteServiceIDOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*DeleteServiceIDOptions) SetID added in v0.17.2 

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

SetID : Allow user to set ID

type 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:"id" validate:"required,ne="`

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

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

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:"IAM-ApiKey,omitempty"`

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

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

GetAPIKeysDetailsOptions : The GetAPIKeysDetails options.

func (*GetAPIKeysDetailsOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*GetAPIKeysDetailsOptions) SetIamAPIKey added in v0.17.2 

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

SetIamAPIKey : Allow user to set IamAPIKey

func (*GetAPIKeysDetailsOptions) SetIncludeHistory added in v0.17.2 

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

SetIncludeHistory : Allow user to set IncludeHistory

type GetServiceIDOptions added in v0.17.2 

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

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

	// 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 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) 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. Refresh tokens will not work any more for this API key. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.

func (*IamIdentityV1) 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) 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) GetEnableGzipCompression added in v0.12.1 

func (iamIdentity *IamIdentityV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

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.

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

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

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:"account_id,omitempty"`

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

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

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

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

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

	// Optional sort property, valid values are name, description, created_at and created_by. If specified, the items are
	// sorted by the value of this property.
	Sort *string `json:"sort,omitempty"`

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

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

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

ListAPIKeysOptions : The ListAPIKeys options.

func (*ListAPIKeysOptions) SetAccountID added in v0.17.2 

func (options *ListAPIKeysOptions) SetAccountID(accountID string) *ListAPIKeysOptions

SetAccountID : Allow user to set AccountID

func (*ListAPIKeysOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*ListAPIKeysOptions) SetIamID added in v0.17.2 

func (options *ListAPIKeysOptions) SetIamID(iamID string) *ListAPIKeysOptions

SetIamID : Allow user to set IamID

func (*ListAPIKeysOptions) SetIncludeHistory added in v0.17.2 

func (options *ListAPIKeysOptions) SetIncludeHistory(includeHistory bool) *ListAPIKeysOptions

SetIncludeHistory : Allow user to set IncludeHistory

func (*ListAPIKeysOptions) SetOrder added in v0.17.2 

func (options *ListAPIKeysOptions) SetOrder(order string) *ListAPIKeysOptions

SetOrder : Allow user to set Order

func (*ListAPIKeysOptions) SetPagesize added in v0.17.2 

func (options *ListAPIKeysOptions) SetPagesize(pagesize int64) *ListAPIKeysOptions

SetPagesize : Allow user to set Pagesize

func (*ListAPIKeysOptions) SetPagetoken added in v0.17.2 

func (options *ListAPIKeysOptions) SetPagetoken(pagetoken string) *ListAPIKeysOptions

SetPagetoken : Allow user to set Pagetoken

func (*ListAPIKeysOptions) SetScope added in v0.17.2 

func (options *ListAPIKeysOptions) SetScope(scope string) *ListAPIKeysOptions

SetScope : Allow user to set Scope

func (*ListAPIKeysOptions) SetSort added in v0.17.2 

func (options *ListAPIKeysOptions) SetSort(sort string) *ListAPIKeysOptions

SetSort : Allow user to set Sort

func (*ListAPIKeysOptions) SetType added in v0.17.2 

func (options *ListAPIKeysOptions) SetType(typeVar string) *ListAPIKeysOptions

SetType : Allow user to set Type

type ListServiceIdsOptions 

type ListServiceIdsOptions struct {
	// Account ID of the service ID(s) to query. This parameter is required (unless using a pagetoken).
	AccountID *string `json:"account_id,omitempty"`

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

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

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

	// Optional sort property, valid values are name, description, created_at and modified_at. If specified, the items are
	// sorted by the value of this property.
	Sort *string `json:"sort,omitempty"`

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

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

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

ListServiceIdsOptions : The ListServiceIds options.

func (*ListServiceIdsOptions) SetAccountID 

func (options *ListServiceIdsOptions) SetAccountID(accountID string) *ListServiceIdsOptions

SetAccountID : Allow user to set AccountID

func (*ListServiceIdsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListServiceIdsOptions) SetIncludeHistory 

func (options *ListServiceIdsOptions) SetIncludeHistory(includeHistory bool) *ListServiceIdsOptions

SetIncludeHistory : Allow user to set IncludeHistory

func (*ListServiceIdsOptions) SetName 

func (options *ListServiceIdsOptions) SetName(name string) *ListServiceIdsOptions

SetName : Allow user to set Name

func (*ListServiceIdsOptions) SetOrder 

func (options *ListServiceIdsOptions) SetOrder(order string) *ListServiceIdsOptions

SetOrder : Allow user to set Order

func (*ListServiceIdsOptions) SetPagesize 

func (options *ListServiceIdsOptions) SetPagesize(pagesize int64) *ListServiceIdsOptions

SetPagesize : Allow user to set Pagesize

func (*ListServiceIdsOptions) SetPagetoken 

func (options *ListServiceIdsOptions) SetPagetoken(pagetoken string) *ListServiceIdsOptions

SetPagetoken : Allow user to set Pagetoken

func (*ListServiceIdsOptions) SetSort 

func (options *ListServiceIdsOptions) SetSort(sort string) *ListServiceIdsOptions

SetSort : Allow user to set Sort

type LockAPIKeyOptions added in v0.17.2 

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

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

LockAPIKeyOptions : The LockAPIKey options.

func (*LockAPIKeyOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*LockAPIKeyOptions) SetID added in v0.17.2 

func (options *LockAPIKeyOptions) SetID(id string) *LockAPIKeyOptions

SetID : Allow user to set ID

type LockServiceIDOptions added in v0.17.2 

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

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

LockServiceIDOptions : The LockServiceID options.

func (*LockServiceIDOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*LockServiceIDOptions) SetID added in v0.17.2 

func (options *LockServiceIDOptions) SetID(id string) *LockServiceIDOptions

SetID : Allow user to set ID

type 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,omitempty"`

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

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

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

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

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

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

UnlockAPIKeyOptions : The UnlockAPIKey options.

func (*UnlockAPIKeyOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*UnlockAPIKeyOptions) SetID added in v0.17.2 

func (options *UnlockAPIKeyOptions) SetID(id string) *UnlockAPIKeyOptions

SetID : Allow user to set ID

type UnlockServiceIDOptions added in v0.17.2 

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

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

UnlockServiceIDOptions : The UnlockServiceID options.

func (*UnlockServiceIDOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*UnlockServiceIDOptions) SetID added in v0.17.2 

func (options *UnlockServiceIDOptions) SetID(id string) *UnlockServiceIDOptions

SetID : Allow user to set ID

type UpdateAPIKeyOptions added in v0.17.2 

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

	// Version of the API key to be updated. Specify the version that you retrieved when reading the API key. This value
	// helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result
	// in stale updates.
	IfMatch *string `json:"If-Match" validate:"required"`

	// The name of the API key to update. If specified in the request the parameter must not be empty. The name is not
	// checked for uniqueness. Failure to this will result in an Error condition.
	Name *string `json:"name,omitempty"`

	// The description of the API key to update. If specified an empty description will clear the description of the API
	// key. If a non empty value is provided the API key will be updated.
	Description *string `json:"description,omitempty"`

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

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

	// Version of the service ID to be updated. Specify the version that you retrieved as entity_tag (ETag header) when
	// reading the service ID. This value helps identifying parallel usage of this API. Pass * to indicate to update any
	// version available. This might result in stale updates.
	IfMatch *string `json:"If-Match" validate:"required"`

	// The name of the service ID to update. If specified in the request the parameter must not be empty. The name is not
	// checked for uniqueness. Failure to this will result in an Error condition.
	Name *string `json:"name,omitempty"`

	// The description of the service ID to update. If specified an empty description will clear the description of the
	// service ID. If an non empty value is provided the service ID will be updated.
	Description *string `json:"description,omitempty"`

	// List of CRNs which point to the services connected to this service ID. If specified an empty list will clear all
	// existing unique instance crns of the service ID.
	UniqueInstanceCrns []string `json:"unique_instance_crns,omitempty"`

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

UpdateServiceIDOptions : The UpdateServiceID options.

func (*UpdateServiceIDOptions) SetDescription added in v0.17.2 

func (options *UpdateServiceIDOptions) SetDescription(description string) *UpdateServiceIDOptions

SetDescription : Allow user to set Description

func (*UpdateServiceIDOptions) SetHeaders added in v0.17.2 

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

SetHeaders : Allow user to set Headers

func (*UpdateServiceIDOptions) SetID added in v0.17.2 

func (options *UpdateServiceIDOptions) SetID(id string) *UpdateServiceIDOptions

SetID : Allow user to set ID

func (*UpdateServiceIDOptions) SetIfMatch added in v0.17.2 

func (options *UpdateServiceIDOptions) SetIfMatch(ifMatch string) *UpdateServiceIDOptions

SetIfMatch : Allow user to set IfMatch

func (*UpdateServiceIDOptions) SetName added in v0.17.2 

func (options *UpdateServiceIDOptions) SetName(name string) *UpdateServiceIDOptions

SetName : Allow user to set Name

func (*UpdateServiceIDOptions) SetUniqueInstanceCrns added in v0.17.2 

func (options *UpdateServiceIDOptions) SetUniqueInstanceCrns(uniqueInstanceCrns []string) *UpdateServiceIDOptions

SetUniqueInstanceCrns : Allow user to set UniqueInstanceCrns

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.