credentialsgroup

Documentation

Index

• func ValidateCredentialsGroupID(id string) error
• func ValidateDisplayName(name string) error
• type CredentialsGroup
• type CredentialsGroupDeleteResponse
• type CredentialsGroupResponse
• type ObjectStorageCredentialsGroupService
  • func New(c common.Client) *ObjectStorageCredentialsGroupService
  • func (svc *ObjectStorageCredentialsGroupService) Create(ctx context.Context, projectID, displayName string) (err error)
  • func (svc *ObjectStorageCredentialsGroupService) Delete(ctx context.Context, projectID, credentialsGroupId string) (err error)
  • func (svc *ObjectStorageCredentialsGroupService) List(ctx context.Context, projectID string) (res CredentialsGroupResponse, err error)

Functions

func ValidateCredentialsGroupID

func ValidateCredentialsGroupID(id string) error

ValidateCredentialsGroupID validates a given credentials group ID

func ValidateDisplayName

func ValidateDisplayName(name string) error

ValidateDisplayName validates a given credentialsGroup name

Types

type CredentialsGroup

type CredentialsGroup struct {
	CredentialsGroupID string `json:"credentialsGroupId"`
	URN                string `json:"urn"`
	DisplayName        string `json:"displayName"`
}

CredentialsGroup holds all the credentialsGroup information

type CredentialsGroupDeleteResponse

type CredentialsGroupDeleteResponse struct {
	Project            string `json:"project"`
	CredentialsGroupId string `json:"credentialsGroupId"`
}

type CredentialsGroupResponse

type CredentialsGroupResponse struct {
	Project           string             `json:"project"`
	CredentialsGroups []CredentialsGroup `json:"credentialsGroups"`
}

CredentialsGroupResponse is a struct representation of stackit's object storage api response for a credentialsGroup

type ObjectStorageCredentialsGroupService

type ObjectStorageCredentialsGroupService common.Service

ObjectStorageCredentialsGroupService is the service that handles CRUD functionality for SKE credentialsGroups

func New

func New(c common.Client) *ObjectStorageCredentialsGroupService

New returns a new handler for the service

func (*ObjectStorageCredentialsGroupService) Create

func (svc *ObjectStorageCredentialsGroupService) Create(ctx context.Context, projectID, displayName string) (err error)

Create creates a new credentialsGroup See also https://api.stackit.schwarz/object-storage-service/openapi.v1.html#operation/create-credentials-group-v1-project-projectId-credentials-group-post

func (*ObjectStorageCredentialsGroupService) Delete

func (svc *ObjectStorageCredentialsGroupService) Delete(ctx context.Context, projectID, credentialsGroupId string) (err error)

Delete deletes a credentialsGroup See also https://api.stackit.schwarz/object-storage-service/openapi.v1.html#operation/delete-credentials-group-v1-project-projectId-credentials-group-groupId-delete

func (*ObjectStorageCredentialsGroupService) List

func (svc *ObjectStorageCredentialsGroupService) List(ctx context.Context, projectID string) (res CredentialsGroupResponse, err error)

List returns the a credentialsGroup by project ID and credentialsGroup name See also https://api.stackit.schwarz/object-storage-service/openapi.v1.html#operation/get-credentials-groups-v1-project-projectId-credentials-groups-get