identity

package
v1.11.0-pre Latest Latest
Warning

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

Go to latest
Published: Dec 4, 2020 License: Apache-2.0 Imports: 3 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddGroupMemberBody

type AddGroupMemberBody struct {
	Name string `json:"name"`
}

type AddGroupRoleBody

type AddGroupRoleBody struct {
	Name string `json:"name"`
}

type AddMemberBody

type AddMemberBody struct {
	Name string `json:"name"`
}

type CreateGroupBody

type CreateGroupBody struct {
	Name string `json:"name"`
}

type CreateRoleBody

type CreateRoleBody struct {
	Name string `json:"name"`
}

type EcJwk added in v1.8.0

type EcJwk struct {
	Alg *EcJwkAlg `json:"alg,omitempty"`
	Crv *string   `json:"crv,omitempty"`
	D   *string   `json:"d,omitempty"`
	Kid *string   `json:"kid,omitempty"`
	Kty *EcJwkKty `json:"kty,omitempty"`
	X   *string   `json:"x,omitempty"`
	Y   *string   `json:"y,omitempty"`
}

type EcJwkAlg added in v1.8.0

type EcJwkAlg string
const (
	EcJwkAlgEs256 EcJwkAlg = "ES256"
	EcJwkAlgEs384 EcJwkAlg = "ES384"
	EcJwkAlgEs512 EcJwkAlg = "ES512"
)

List of EcJwkAlg

type EcJwkKty added in v1.8.0

type EcJwkKty string
const (
	EcJwkKtyEc EcJwkKty = "EC"
)

List of EcJwkKty

type Group

type Group struct {
	CreatedAt   string `json:"createdAt"`
	CreatedBy   string `json:"createdBy"`
	MemberCount int32  `json:"memberCount"`
	Name        string `json:"name"`
	RoleCount   int32  `json:"roleCount"`
	Tenant      string `json:"tenant"`
}

type GroupMember

type GroupMember struct {
	AddedAt   string `json:"addedAt"`
	AddedBy   string `json:"addedBy"`
	Group     string `json:"group"`
	Principal string `json:"principal"`
	Tenant    string `json:"tenant"`
}

Represents a member that belongs to a group

type GroupRole

type GroupRole struct {
	AddedAt string `json:"addedAt"`
	AddedBy string `json:"addedBy"`
	Group   string `json:"group"`
	Role    string `json:"role"`
	Tenant  string `json:"tenant"`
}

Represents a role that is assigned to a group

type ListGroupsQueryParams added in v1.3.0

type ListGroupsQueryParams struct {
	// Access : List only the groups with specified access permission.
	Access ListGroupsaccess `key:"access"`
}

ListGroupsQueryParams represents valid query parameters for the ListGroups operation For convenience ListGroupsQueryParams can be formed in a single statement, for example:

`v := ListGroupsQueryParams{}.SetAccess(...)`

func (ListGroupsQueryParams) SetAccess added in v1.3.0

type ListGroupsaccess added in v1.3.0

type ListGroupsaccess string

ListGroupsaccess : List only the groups with specified access permission.

const (
	ListGroupsaccessWrite ListGroupsaccess = "write"
)

List of ListGroupsaccess values

type ListMemberPermissionsQueryParams added in v1.7.0

type ListMemberPermissionsQueryParams struct {
	// ScopeFilter : List only the permissions matching the scope filter.
	ScopeFilter string `key:"scopeFilter"`
}

ListMemberPermissionsQueryParams represents valid query parameters for the ListMemberPermissions operation For convenience ListMemberPermissionsQueryParams can be formed in a single statement, for example:

`v := ListMemberPermissionsQueryParams{}.SetScopeFilter(...)`

func (ListMemberPermissionsQueryParams) SetScopeFilter added in v1.7.0

type Member

type Member struct {
	// When the principal was added to the tenant.
	AddedAt    string            `json:"addedAt"`
	AddedBy    string            `json:"addedBy"`
	GroupCount int32             `json:"groupCount"`
	Name       string            `json:"name"`
	Tenant     string            `json:"tenant"`
	ExpiresAt  *string           `json:"expiresAt,omitempty"`
	Profile    *PrincipalProfile `json:"profile,omitempty"`
	Visible    *bool             `json:"visible,omitempty"`
}

Represents a member that belongs to a tenant.

type PermissionString added in v1.8.0

type PermissionString string

type Principal

type Principal struct {
	CreatedAt string            `json:"createdAt"`
	CreatedBy string            `json:"createdBy"`
	Kind      PrincipalKind     `json:"kind"`
	Name      string            `json:"name"`
	Tenants   []string          `json:"tenants"`
	UpdatedAt string            `json:"updatedAt"`
	UpdatedBy string            `json:"updatedBy"`
	Profile   *PrincipalProfile `json:"profile,omitempty"`
}

type PrincipalKind

type PrincipalKind string

PrincipalKind :

const (
	PrincipalKindUser           PrincipalKind = "user"
	PrincipalKindServiceAccount PrincipalKind = "service_account"
	PrincipalKindService        PrincipalKind = "service"
)

List of PrincipalKind

type PrincipalProfile

type PrincipalProfile struct {
	Email    *string `json:"email,omitempty"`
	FullName *string `json:"fullName,omitempty"`
}

Profile information for a principal

type PrincipalPublicKey added in v1.8.0

type PrincipalPublicKey struct {
	CreatedAt string                   `json:"createdAt"`
	CreatedBy string                   `json:"createdBy"`
	Key       EcJwk                    `json:"key"`
	Status    PrincipalPublicKeyStatus `json:"status"`
	UpdatedAt string                   `json:"updatedAt"`
	UpdatedBy string                   `json:"updatedBy"`
}

type PrincipalPublicKeyStatus added in v1.8.0

type PrincipalPublicKeyStatus string
const (
	PrincipalPublicKeyStatusActive   PrincipalPublicKeyStatus = "active"
	PrincipalPublicKeyStatusInactive PrincipalPublicKeyStatus = "inactive"
	PrincipalPublicKeyStatusDeleted  PrincipalPublicKeyStatus = "deleted"
)

List of PrincipalPublicKeyStatus

type PrincipalPublicKeyStatusBody added in v1.8.0

type PrincipalPublicKeyStatusBody struct {
	Status PrincipalPublicKeyStatusBodyStatus `json:"status"`
}

type PrincipalPublicKeyStatusBodyStatus added in v1.8.0

type PrincipalPublicKeyStatusBodyStatus string
const (
	PrincipalPublicKeyStatusBodyStatusActive   PrincipalPublicKeyStatusBodyStatus = "active"
	PrincipalPublicKeyStatusBodyStatusInactive PrincipalPublicKeyStatusBodyStatus = "inactive"
)

List of PrincipalPublicKeyStatusBodyStatus

type PrincipalPublicKeys added in v1.8.0

type PrincipalPublicKeys []PrincipalPublicKey

type Role

type Role struct {
	CreatedAt   string   `json:"createdAt"`
	CreatedBy   string   `json:"createdBy"`
	Name        string   `json:"name"`
	Tenant      string   `json:"tenant"`
	Permissions []string `json:"permissions,omitempty"`
}

type RolePermission

type RolePermission struct {
	AddedAt    string `json:"addedAt"`
	AddedBy    string `json:"addedBy"`
	Permission string `json:"permission"`
	Role       string `json:"role"`
	Tenant     string `json:"tenant"`
}

type Service

type Service services.BaseService

func NewService

func NewService(iClient services.IClient) *Service

NewService creates a new identity service client from the given Config

func (*Service) AddGroupMember

func (s *Service) AddGroupMember(group string, addGroupMemberBody AddGroupMemberBody, resp ...*http.Response) (*GroupMember, error)

AddGroupMember - identity service endpoint Adds a member to a given group. Parameters:

group: The group name.
addGroupMemberBody: The member to add to a group.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) AddGroupRole

func (s *Service) AddGroupRole(group string, addGroupRoleBody AddGroupRoleBody, resp ...*http.Response) (*GroupRole, error)

AddGroupRole - identity service endpoint Adds a role to a given group. Parameters:

group: The group name.
addGroupRoleBody: The role to add to a group.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) AddMember

func (s *Service) AddMember(addMemberBody AddMemberBody, resp ...*http.Response) (*Member, error)

AddMember - identity service endpoint Adds a member to a given tenant. Parameters:

addMemberBody: The member to associate with a tenant.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) AddPrincipalPublicKey added in v1.8.0

func (s *Service) AddPrincipalPublicKey(principal string, ecJwk EcJwk, resp ...*http.Response) (*PrincipalPublicKey, error)

AddPrincipalPublicKey - identity service endpoint Add service principal public key Parameters:

principal: The principal name.
ecJwk: Service principal public key
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) AddRolePermission

func (s *Service) AddRolePermission(role string, body string, resp ...*http.Response) (*RolePermission, error)

AddRolePermission - identity service endpoint Adds permissions to a role in a given tenant. Parameters:

role: The role name.
body: The permission to add to a role.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) CreateGroup

func (s *Service) CreateGroup(createGroupBody CreateGroupBody, resp ...*http.Response) (*Group, error)

CreateGroup - identity service endpoint Creates a new group in a given tenant. Parameters:

createGroupBody: The group definition.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) CreateRole

func (s *Service) CreateRole(createRoleBody CreateRoleBody, resp ...*http.Response) (*Role, error)

CreateRole - identity service endpoint Creates a new authorization role in a given tenant. Parameters:

createRoleBody: Role definition
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) DeleteGroup

func (s *Service) DeleteGroup(group string, resp ...*http.Response) error

DeleteGroup - identity service endpoint Deletes a group in a given tenant. Parameters:

group: The group name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) DeletePrincipalPublicKey added in v1.8.0

func (s *Service) DeletePrincipalPublicKey(principal string, keyId string, resp ...*http.Response) error

DeletePrincipalPublicKey - identity service endpoint Deletes principal public key Parameters:

principal: The principal name.
keyId: Identifier of a public key.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) DeleteRole

func (s *Service) DeleteRole(role string, resp ...*http.Response) error

DeleteRole - identity service endpoint Deletes a defined role for a given tenant. Parameters:

role: The role name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetGroup

func (s *Service) GetGroup(group string, resp ...*http.Response) (*Group, error)

GetGroup - identity service endpoint Returns information about a given group within a tenant. Parameters:

group: The group name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetGroupMember

func (s *Service) GetGroupMember(group string, member string, resp ...*http.Response) (*GroupMember, error)

GetGroupMember - identity service endpoint Returns information about a given member within a given group. Parameters:

group: The group name.
member: The member name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetGroupRole

func (s *Service) GetGroupRole(group string, role string, resp ...*http.Response) (*GroupRole, error)

GetGroupRole - identity service endpoint Returns information about a given role within a given group. Parameters:

group: The group name.
role: The role name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetMember

func (s *Service) GetMember(member string, resp ...*http.Response) (*Member, error)

GetMember - identity service endpoint Returns a member of a given tenant. Parameters:

member: The member name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetPrincipal

func (s *Service) GetPrincipal(principal string, resp ...*http.Response) (*Principal, error)

GetPrincipal - identity service endpoint Returns the details of a principal, including its tenant membership. Parameters:

principal: The principal name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetPrincipalPublicKey added in v1.8.0

func (s *Service) GetPrincipalPublicKey(principal string, keyId string, resp ...*http.Response) (*PrincipalPublicKey, error)

GetPrincipalPublicKey - identity service endpoint Returns principal public key Parameters:

principal: The principal name.
keyId: Identifier of a public key.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetPrincipalPublicKeys added in v1.8.0

func (s *Service) GetPrincipalPublicKeys(principal string, resp ...*http.Response) (*PrincipalPublicKeys, error)

GetPrincipalPublicKeys - identity service endpoint Returns principal public keys Parameters:

principal: The principal name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetRole

func (s *Service) GetRole(role string, resp ...*http.Response) (*Role, error)

GetRole - identity service endpoint Returns a role for a given tenant. Parameters:

role: The role name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetRolePermission

func (s *Service) GetRolePermission(role string, permission string, resp ...*http.Response) (*RolePermission, error)

GetRolePermission - identity service endpoint Gets a permission for the specified role. Parameters:

role: The role name.
permission: The permission string.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListGroupMembers

func (s *Service) ListGroupMembers(group string, resp ...*http.Response) ([]string, error)

ListGroupMembers - identity service endpoint Returns a list of the members within a given group. Parameters:

group: The group name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListGroupRoles

func (s *Service) ListGroupRoles(group string, resp ...*http.Response) ([]string, error)

ListGroupRoles - identity service endpoint Returns a list of the roles that are attached to a group within a given tenant. Parameters:

group: The group name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListGroups

func (s *Service) ListGroups(query *ListGroupsQueryParams, resp ...*http.Response) ([]string, error)

ListGroups - identity service endpoint List the groups that exist in a given tenant. Parameters:

query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListMemberGroups

func (s *Service) ListMemberGroups(member string, resp ...*http.Response) ([]string, error)

ListMemberGroups - identity service endpoint Returns a list of groups that a member belongs to within a tenant. Parameters:

member: The member name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListMemberPermissions

func (s *Service) ListMemberPermissions(member string, query *ListMemberPermissionsQueryParams, resp ...*http.Response) ([]string, error)

ListMemberPermissions - identity service endpoint Returns a set of permissions granted to the member within the tenant. Parameters:

member: The member name.
query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListMemberRoles

func (s *Service) ListMemberRoles(member string, resp ...*http.Response) ([]string, error)

ListMemberRoles - identity service endpoint Returns a set of roles that a given member holds within the tenant. Parameters:

member: The member name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListMembers

func (s *Service) ListMembers(resp ...*http.Response) ([]string, error)

ListMembers - identity service endpoint Returns a list of members in a given tenant. Parameters:

resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListPrincipals

func (s *Service) ListPrincipals(resp ...*http.Response) ([]string, error)

ListPrincipals - identity service endpoint Returns the list of principals that the Identity service knows about. Parameters:

resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListRoleGroups

func (s *Service) ListRoleGroups(role string, resp ...*http.Response) ([]string, error)

ListRoleGroups - identity service endpoint Gets a list of groups for a role in a given tenant. Parameters:

role: The role name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListRolePermissions

func (s *Service) ListRolePermissions(role string, resp ...*http.Response) ([]string, error)

ListRolePermissions - identity service endpoint Gets the permissions for a role in a given tenant. Parameters:

role: The role name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListRoles

func (s *Service) ListRoles(resp ...*http.Response) ([]string, error)

ListRoles - identity service endpoint Returns all roles for a given tenant. Parameters:

resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) RemoveGroupMember

func (s *Service) RemoveGroupMember(group string, member string, resp ...*http.Response) error

RemoveGroupMember - identity service endpoint Removes the member from a given group. Parameters:

group: The group name.
member: The member name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) RemoveGroupRole

func (s *Service) RemoveGroupRole(group string, role string, resp ...*http.Response) error

RemoveGroupRole - identity service endpoint Removes a role from a given group. Parameters:

group: The group name.
role: The role name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) RemoveMember

func (s *Service) RemoveMember(member string, resp ...*http.Response) error

RemoveMember - identity service endpoint Removes a member from a given tenant Parameters:

member: The member name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) RemoveRolePermission

func (s *Service) RemoveRolePermission(role string, permission string, resp ...*http.Response) error

RemoveRolePermission - identity service endpoint Removes a permission from the role. Parameters:

role: The role name.
permission: The permission string.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) RevokePrincipalAuthTokens added in v1.3.0

func (s *Service) RevokePrincipalAuthTokens(principal string, resp ...*http.Response) error

RevokePrincipalAuthTokens - identity service endpoint Revoke all existing tokens issued to a principal. Principals can reset their password by visiting https://login.splunk.com/en_us/page/lost_password Parameters:

principal: The principal name.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) UpdatePrincipalPublicKey added in v1.8.0

func (s *Service) UpdatePrincipalPublicKey(principal string, keyId string, principalPublicKeyStatusBody PrincipalPublicKeyStatusBody, resp ...*http.Response) (*PrincipalPublicKey, error)

UpdatePrincipalPublicKey - identity service endpoint Update principal public key Parameters:

principal: The principal name.
keyId: Identifier of a public key.
principalPublicKeyStatusBody: Status of the public key
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ValidateToken

func (s *Service) ValidateToken(query *ValidateTokenQueryParams, resp ...*http.Response) (*ValidateInfo, error)

ValidateToken - identity service endpoint Validates the access token obtained from the authorization header and returns the principal name and tenant memberships. Parameters:

query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

type Servicer

type Servicer interface {
	//interfaces that are auto-generated in interface_generated.go
	ServicerGenerated
}

Servicer represents the interface for implementing all endpoints for this service

type ServicerGenerated added in v1.10.0

type ServicerGenerated interface {
	/*
		AddGroupMember - identity service endpoint
		Adds a member to a given group.
		Parameters:
			group: The group name.
			addGroupMemberBody: The member to add to a group.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	AddGroupMember(group string, addGroupMemberBody AddGroupMemberBody, resp ...*http.Response) (*GroupMember, error)
	/*
		AddGroupRole - identity service endpoint
		Adds a role to a given group.
		Parameters:
			group: The group name.
			addGroupRoleBody: The role to add to a group.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	AddGroupRole(group string, addGroupRoleBody AddGroupRoleBody, resp ...*http.Response) (*GroupRole, error)
	/*
		AddMember - identity service endpoint
		Adds a member to a given tenant.
		Parameters:
			addMemberBody: The member to associate with a tenant.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	AddMember(addMemberBody AddMemberBody, resp ...*http.Response) (*Member, error)
	/*
		AddPrincipalPublicKey - identity service endpoint
		Add service principal public key
		Parameters:
			principal: The principal name.
			ecJwk: Service principal public key
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	AddPrincipalPublicKey(principal string, ecJwk EcJwk, resp ...*http.Response) (*PrincipalPublicKey, error)
	/*
		AddRolePermission - identity service endpoint
		Adds permissions to a role in a given tenant.
		Parameters:
			role: The role name.
			body: The permission to add to a role.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	AddRolePermission(role string, body string, resp ...*http.Response) (*RolePermission, error)
	/*
		CreateGroup - identity service endpoint
		Creates a new group in a given tenant.
		Parameters:
			createGroupBody: The group definition.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateGroup(createGroupBody CreateGroupBody, resp ...*http.Response) (*Group, error)
	/*
		CreateRole - identity service endpoint
		Creates a new authorization role in a given tenant.
		Parameters:
			createRoleBody: Role definition
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateRole(createRoleBody CreateRoleBody, resp ...*http.Response) (*Role, error)
	/*
		DeleteGroup - identity service endpoint
		Deletes a group in a given tenant.
		Parameters:
			group: The group name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteGroup(group string, resp ...*http.Response) error
	/*
		DeletePrincipalPublicKey - identity service endpoint
		Deletes principal public key
		Parameters:
			principal: The principal name.
			keyId: Identifier of a public key.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeletePrincipalPublicKey(principal string, keyId string, resp ...*http.Response) error
	/*
		DeleteRole - identity service endpoint
		Deletes a defined role for a given tenant.
		Parameters:
			role: The role name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteRole(role string, resp ...*http.Response) error
	/*
		GetGroup - identity service endpoint
		Returns information about a given group within a tenant.
		Parameters:
			group: The group name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetGroup(group string, resp ...*http.Response) (*Group, error)
	/*
		GetGroupMember - identity service endpoint
		Returns information about a given member within a given group.
		Parameters:
			group: The group name.
			member: The member name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetGroupMember(group string, member string, resp ...*http.Response) (*GroupMember, error)
	/*
		GetGroupRole - identity service endpoint
		Returns information about a given role within a given group.
		Parameters:
			group: The group name.
			role: The role name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetGroupRole(group string, role string, resp ...*http.Response) (*GroupRole, error)
	/*
		GetMember - identity service endpoint
		Returns a member of a given tenant.
		Parameters:
			member: The member name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetMember(member string, resp ...*http.Response) (*Member, error)
	/*
		GetPrincipal - identity service endpoint
		Returns the details of a principal, including its tenant membership.
		Parameters:
			principal: The principal name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetPrincipal(principal string, resp ...*http.Response) (*Principal, error)
	/*
		GetPrincipalPublicKey - identity service endpoint
		Returns principal public key
		Parameters:
			principal: The principal name.
			keyId: Identifier of a public key.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetPrincipalPublicKey(principal string, keyId string, resp ...*http.Response) (*PrincipalPublicKey, error)
	/*
		GetPrincipalPublicKeys - identity service endpoint
		Returns principal public keys
		Parameters:
			principal: The principal name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetPrincipalPublicKeys(principal string, resp ...*http.Response) (*PrincipalPublicKeys, error)
	/*
		GetRole - identity service endpoint
		Returns a role for a given tenant.
		Parameters:
			role: The role name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetRole(role string, resp ...*http.Response) (*Role, error)
	/*
		GetRolePermission - identity service endpoint
		Gets a permission for the specified role.
		Parameters:
			role: The role name.
			permission: The permission string.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetRolePermission(role string, permission string, resp ...*http.Response) (*RolePermission, error)
	/*
		ListGroupMembers - identity service endpoint
		Returns a list of the members within a given group.
		Parameters:
			group: The group name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListGroupMembers(group string, resp ...*http.Response) ([]string, error)
	/*
		ListGroupRoles - identity service endpoint
		Returns a list of the roles that are attached to a group within a given tenant.
		Parameters:
			group: The group name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListGroupRoles(group string, resp ...*http.Response) ([]string, error)
	/*
		ListGroups - identity service endpoint
		List the groups that exist in a given tenant.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListGroups(query *ListGroupsQueryParams, resp ...*http.Response) ([]string, error)
	/*
		ListMemberGroups - identity service endpoint
		Returns a list of groups that a member belongs to within a tenant.
		Parameters:
			member: The member name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListMemberGroups(member string, resp ...*http.Response) ([]string, error)
	/*
		ListMemberPermissions - identity service endpoint
		Returns a set of permissions granted to the member within the tenant.
		Parameters:
			member: The member name.
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListMemberPermissions(member string, query *ListMemberPermissionsQueryParams, resp ...*http.Response) ([]string, error)
	/*
		ListMemberRoles - identity service endpoint
		Returns a set of roles that a given member holds within the tenant.
		Parameters:
			member: The member name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListMemberRoles(member string, resp ...*http.Response) ([]string, error)
	/*
		ListMembers - identity service endpoint
		Returns a list of members in a given tenant.
		Parameters:
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListMembers(resp ...*http.Response) ([]string, error)
	/*
		ListPrincipals - identity service endpoint
		Returns the list of principals that the Identity service knows about.
		Parameters:
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListPrincipals(resp ...*http.Response) ([]string, error)
	/*
		ListRoleGroups - identity service endpoint
		Gets a list of groups for a role in a given tenant.
		Parameters:
			role: The role name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListRoleGroups(role string, resp ...*http.Response) ([]string, error)
	/*
		ListRolePermissions - identity service endpoint
		Gets the permissions for a role in a given tenant.
		Parameters:
			role: The role name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListRolePermissions(role string, resp ...*http.Response) ([]string, error)
	/*
		ListRoles - identity service endpoint
		Returns all roles for a given tenant.
		Parameters:
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListRoles(resp ...*http.Response) ([]string, error)
	/*
		RemoveGroupMember - identity service endpoint
		Removes the member from a given group.
		Parameters:
			group: The group name.
			member: The member name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	RemoveGroupMember(group string, member string, resp ...*http.Response) error
	/*
		RemoveGroupRole - identity service endpoint
		Removes a role from a given group.
		Parameters:
			group: The group name.
			role: The role name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	RemoveGroupRole(group string, role string, resp ...*http.Response) error
	/*
		RemoveMember - identity service endpoint
		Removes a member from a given tenant
		Parameters:
			member: The member name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	RemoveMember(member string, resp ...*http.Response) error
	/*
		RemoveRolePermission - identity service endpoint
		Removes a permission from the role.
		Parameters:
			role: The role name.
			permission: The permission string.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	RemoveRolePermission(role string, permission string, resp ...*http.Response) error
	/*
		RevokePrincipalAuthTokens - identity service endpoint
		Revoke all existing tokens issued to a principal. Principals can reset their password by visiting https://login.splunk.com/en_us/page/lost_password
		Parameters:
			principal: The principal name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	RevokePrincipalAuthTokens(principal string, resp ...*http.Response) error
	/*
		UpdatePrincipalPublicKey - identity service endpoint
		Update principal public key
		Parameters:
			principal: The principal name.
			keyId: Identifier of a public key.
			principalPublicKeyStatusBody: Status of the public key
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	UpdatePrincipalPublicKey(principal string, keyId string, principalPublicKeyStatusBody PrincipalPublicKeyStatusBody, resp ...*http.Response) (*PrincipalPublicKey, error)
	/*
		ValidateToken - identity service endpoint
		Validates the access token obtained from the authorization header and returns the principal name and tenant memberships.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ValidateToken(query *ValidateTokenQueryParams, resp ...*http.Response) (*ValidateInfo, error)
}

ServicerGenerated represents the interface for implementing all endpoints for this service

type Tenant

type Tenant struct {
	CreatedAt     string       `json:"createdAt"`
	CreatedBy     string       `json:"createdBy"`
	Name          string       `json:"name"`
	Status        TenantStatus `json:"status"`
	UseDefaultIdp *bool        `json:"useDefaultIdp,omitempty"`
}

type TenantName

type TenantName string

type TenantStatus

type TenantStatus string

TenantStatus :

const (
	TenantStatusProvisioning TenantStatus = "provisioning"
	TenantStatusFailed       TenantStatus = "failed"
	TenantStatusReady        TenantStatus = "ready"
	TenantStatusDeleting     TenantStatus = "deleting"
	TenantStatusDeleted      TenantStatus = "deleted"
	TenantStatusTombstoned   TenantStatus = "tombstoned"
	TenantStatusSuspended    TenantStatus = "suspended"
)

List of TenantStatus

type ValidateInfo

type ValidateInfo struct {
	ClientId  string           `json:"clientId"`
	Kind      ValidateInfoKind `json:"kind"`
	Name      string           `json:"name"`
	Principal *Principal       `json:"principal,omitempty"`
	Tenant    *Tenant          `json:"tenant,omitempty"`
}

type ValidateInfoKind

type ValidateInfoKind string
const (
	ValidateInfoKindPrincipal ValidateInfoKind = "principal"
	ValidateInfoKindApiKey    ValidateInfoKind = "api_key"
)

List of ValidateInfoKind

type ValidateTokenQueryParams

type ValidateTokenQueryParams struct {
	// Include : Include additional information to return when validating tenant membership. Valid parameters [tenant, principal]
	Include ValidateTokeninclude `key:"include"`
}

ValidateTokenQueryParams represents valid query parameters for the ValidateToken operation For convenience ValidateTokenQueryParams can be formed in a single statement, for example:

`v := ValidateTokenQueryParams{}.SetInclude(...)`

func (ValidateTokenQueryParams) SetInclude

type ValidateTokeninclude

type ValidateTokeninclude []ValidateTokenincludeEnum

ValidateTokeninclude : Include additional information to return when validating tenant membership. Valid parameters [tenant, principal]

type ValidateTokenincludeEnum added in v1.1.0

type ValidateTokenincludeEnum string

ValidateTokenincludeEnum : Include additional information to return when validating tenant membership. Valid parameters [tenant, principal]

const (
	ValidateTokenincludeTenant    ValidateTokenincludeEnum = "tenant"
	ValidateTokenincludePrincipal ValidateTokenincludeEnum = "principal"
)

List of ValidateTokeninclude values

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL