identity

package
v1.11.1 Latest Latest
Warning

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

Go to latest
Published: Feb 2, 2021 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 AddRolePermissionBody

type AddRolePermissionBody struct {
	Permission string `json:"permission"`
}

type CreateGroupBody

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

type CreatePrincipalBody added in v1.11.0

type CreatePrincipalBody struct {
	Kind        PrincipalKind           `json:"kind"`
	Credentials CredentialList          `json:"credentials,omitempty"`
	Enabled     *bool                   `json:"enabled,omitempty"`
	Key         *EcJwk                  `json:"key,omitempty"`
	Name        *string                 `json:"name,omitempty"`
	Profile     *CreatePrincipalProfile `json:"profile,omitempty"`
}

Payload when creating a principal

type CreatePrincipalProfile added in v1.11.0

type CreatePrincipalProfile struct {
	Email     string `json:"email"`
	FirstName string `json:"firstName"`
	LastName  string `json:"lastName"`
}

Payload when creating Principal profile

type CreatePrincipalQueryParams added in v1.11.0

type CreatePrincipalQueryParams struct {
	// InviteId : The invite ID.
	InviteId string `key:"inviteID"`
}

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

`v := CreatePrincipalQueryParams{}.SetInviteId(...)`

func (CreatePrincipalQueryParams) SetInviteId added in v1.11.0

type CreateRoleBody

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

type Credential added in v1.11.0

type Credential struct {
	Type  CredentialType `json:"type"`
	Value string         `json:"value"`
}

Principal credential

type CredentialList added in v1.11.0

type CredentialList []Credential

List of credentials

type CredentialType added in v1.11.0

type CredentialType string
const (
	CredentialTypePassword CredentialType = "password"
)

List of CredentialType

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 {
	Name        string  `json:"name"`
	CreatedAt   *string `json:"createdAt,omitempty"`
	CreatedBy   *string `json:"createdBy,omitempty"`
	MemberCount *int32  `json:"memberCount,omitempty"`
	RoleCount   *int32  `json:"roleCount,omitempty"`
	Tenant      *string `json:"tenant,omitempty"`
}

type GroupList added in v1.11.0

type GroupList struct {
	Items    []Group `json:"items"`
	NextLink string  `json:"nextLink"`
}

A list of group.

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 GroupMemberList added in v1.11.0

type GroupMemberList struct {
	Items    []GroupMember `json:"items"`
	NextLink string        `json:"nextLink"`
}

A list of members belonging to a particular 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 GroupRoleList added in v1.11.0

type GroupRoleList struct {
	Items    []GroupRole `json:"items"`
	NextLink string      `json:"nextLink"`
}

A list of group role.

type ListGroupMembersQueryParams added in v1.11.0

type ListGroupMembersQueryParams struct {
	// Orderby : The sorting order for returning list.
	Orderby string `key:"orderby"`
	// PageSize : The maximize return items count of a list.
	PageSize *int32 `key:"page_size"`
	// PageToken : The cursor to then next page.
	PageToken string `key:"page_token"`
}

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

`v := ListGroupMembersQueryParams{}.SetOrderby(...).SetPageSize(...).SetPageToken(...)`

func (ListGroupMembersQueryParams) SetOrderby added in v1.11.0

func (ListGroupMembersQueryParams) SetPageSize added in v1.11.0

func (ListGroupMembersQueryParams) SetPageToken added in v1.11.0

type ListGroupRolesQueryParams added in v1.11.0

type ListGroupRolesQueryParams struct {
	// Orderby : The sorting order for returning list.
	Orderby string `key:"orderby"`
	// PageSize : The maximize return items count of a list.
	PageSize *int32 `key:"page_size"`
	// PageToken : The cursor to then next page.
	PageToken string `key:"page_token"`
}

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

`v := ListGroupRolesQueryParams{}.SetOrderby(...).SetPageSize(...).SetPageToken(...)`

func (ListGroupRolesQueryParams) SetOrderby added in v1.11.0

func (ListGroupRolesQueryParams) SetPageSize added in v1.11.0

func (ListGroupRolesQueryParams) SetPageToken added in v1.11.0

type ListGroupsQueryParams added in v1.3.0

type ListGroupsQueryParams struct {
	// Access : List only the groups with specified access permission.
	Access ListGroupsaccess `key:"access"`
	// Orderby : The sorting order for returning list.
	Orderby string `key:"orderby"`
	// PageSize : The maximize return items count of a list.
	PageSize *int32 `key:"page_size"`
	// PageToken : The cursor to then next page.
	PageToken string `key:"page_token"`
}

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

`v := ListGroupsQueryParams{}.SetAccess(...).SetOrderby(...).SetPageSize(...).SetPageToken(...)`

func (ListGroupsQueryParams) SetAccess added in v1.3.0

func (ListGroupsQueryParams) SetOrderby added in v1.11.0

func (ListGroupsQueryParams) SetPageSize added in v1.11.0

func (ListGroupsQueryParams) SetPageToken added in v1.11.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 ListMemberGroupsQueryParams added in v1.11.0

type ListMemberGroupsQueryParams struct {
	// Orderby : The sorting order for returning list.
	Orderby string `key:"orderby"`
	// PageSize : The maximize return items count of a list.
	PageSize *int32 `key:"page_size"`
	// PageToken : The cursor to then next page.
	PageToken string `key:"page_token"`
}

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

`v := ListMemberGroupsQueryParams{}.SetOrderby(...).SetPageSize(...).SetPageToken(...)`

func (ListMemberGroupsQueryParams) SetOrderby added in v1.11.0

func (ListMemberGroupsQueryParams) SetPageSize added in v1.11.0

func (ListMemberGroupsQueryParams) SetPageToken added in v1.11.0

type ListMemberPermissionsQueryParams added in v1.7.0

type ListMemberPermissionsQueryParams struct {
	// Orderby : The sorting order for returning list.
	Orderby string `key:"orderby"`
	// PageSize : The maximize return items count of a list.
	PageSize *int32 `key:"page_size"`
	// PageToken : The cursor to then next page.
	PageToken string `key:"page_token"`
	// ScopeFilter : List only the permissions matching the scope filter.
	ScopeFilter string `key:"scope_filter"`
}

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

`v := ListMemberPermissionsQueryParams{}.SetOrderby(...).SetPageSize(...).SetPageToken(...).SetScopeFilter(...)`

func (ListMemberPermissionsQueryParams) SetOrderby added in v1.11.0

func (ListMemberPermissionsQueryParams) SetPageSize added in v1.11.0

func (ListMemberPermissionsQueryParams) SetPageToken added in v1.11.0

func (ListMemberPermissionsQueryParams) SetScopeFilter added in v1.7.0

type ListMemberRolesQueryParams added in v1.11.0

type ListMemberRolesQueryParams struct {
	// Orderby : The sorting order for returning list.
	Orderby string `key:"orderby"`
	// PageSize : The maximize return items count of a list.
	PageSize *int32 `key:"page_size"`
	// PageToken : The cursor to then next page.
	PageToken string `key:"page_token"`
}

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

`v := ListMemberRolesQueryParams{}.SetOrderby(...).SetPageSize(...).SetPageToken(...)`

func (ListMemberRolesQueryParams) SetOrderby added in v1.11.0

func (ListMemberRolesQueryParams) SetPageSize added in v1.11.0

func (ListMemberRolesQueryParams) SetPageToken added in v1.11.0

type ListMembersQueryParams added in v1.11.0

type ListMembersQueryParams struct {
	// Kind : Kind of member, one of: [user, service_account, service]
	Kind ListMemberskind `key:"kind"`
	// Orderby : The sorting order for returning list.
	Orderby string `key:"orderby"`
	// PageSize : The maximize return items count of a list.
	PageSize *int32 `key:"page_size"`
	// PageToken : The cursor to then next page.
	PageToken string `key:"page_token"`
}

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

`v := ListMembersQueryParams{}.SetKind(...).SetOrderby(...).SetPageSize(...).SetPageToken(...)`

func (ListMembersQueryParams) SetKind added in v1.11.0

func (ListMembersQueryParams) SetOrderby added in v1.11.0

func (ListMembersQueryParams) SetPageSize added in v1.11.0

func (ListMembersQueryParams) SetPageToken added in v1.11.0

type ListMemberskind added in v1.11.0

type ListMemberskind string

ListMemberskind : Kind of member, one of: [user, service_account, service]

const (
	ListMemberskindUser           ListMemberskind = "user"
	ListMemberskindServiceAccount ListMemberskind = "service_account"
	ListMemberskindService        ListMemberskind = "service"
)

List of ListMemberskind values

type ListPrincipalsQueryParams added in v1.11.0

type ListPrincipalsQueryParams struct {
	// Orderby : The sorting order for returning list.
	Orderby string `key:"orderby"`
	// PageSize : The maximize return items count of a list.
	PageSize *int32 `key:"page_size"`
	// PageToken : The cursor to then next page.
	PageToken string `key:"page_token"`
}

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

`v := ListPrincipalsQueryParams{}.SetOrderby(...).SetPageSize(...).SetPageToken(...)`

func (ListPrincipalsQueryParams) SetOrderby added in v1.11.0

func (ListPrincipalsQueryParams) SetPageSize added in v1.11.0

func (ListPrincipalsQueryParams) SetPageToken added in v1.11.0

type ListRoleGroupsQueryParams added in v1.11.0

type ListRoleGroupsQueryParams struct {
	// Orderby : The sorting order for returning list.
	Orderby string `key:"orderby"`
	// PageSize : The maximize return items count of a list.
	PageSize *int32 `key:"page_size"`
	// PageToken : The cursor to then next page.
	PageToken string `key:"page_token"`
}

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

`v := ListRoleGroupsQueryParams{}.SetOrderby(...).SetPageSize(...).SetPageToken(...)`

func (ListRoleGroupsQueryParams) SetOrderby added in v1.11.0

func (ListRoleGroupsQueryParams) SetPageSize added in v1.11.0

func (ListRoleGroupsQueryParams) SetPageToken added in v1.11.0

type ListRolePermissionsQueryParams added in v1.11.0

type ListRolePermissionsQueryParams struct {
	// Orderby : The sorting order for returning list.
	Orderby string `key:"orderby"`
	// PageSize : The maximize return items count of a list.
	PageSize *int32 `key:"page_size"`
	// PageToken : The cursor to then next page.
	PageToken string `key:"page_token"`
}

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

`v := ListRolePermissionsQueryParams{}.SetOrderby(...).SetPageSize(...).SetPageToken(...)`

func (ListRolePermissionsQueryParams) SetOrderby added in v1.11.0

func (ListRolePermissionsQueryParams) SetPageSize added in v1.11.0

func (ListRolePermissionsQueryParams) SetPageToken added in v1.11.0

type ListRolesQueryParams added in v1.11.0

type ListRolesQueryParams struct {
	// Orderby : The sorting order for returning list.
	Orderby string `key:"orderby"`
	// PageSize : The maximize return items count of a list.
	PageSize *int32 `key:"page_size"`
	// PageToken : The cursor to then next page.
	PageToken string `key:"page_token"`
}

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

`v := ListRolesQueryParams{}.SetOrderby(...).SetPageSize(...).SetPageToken(...)`

func (ListRolesQueryParams) SetOrderby added in v1.11.0

func (ListRolesQueryParams) SetPageSize added in v1.11.0

func (ListRolesQueryParams) SetPageToken added in v1.11.0

type Member

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

Represents a member that belongs to a tenant.

type MemberList added in v1.11.0

type MemberList struct {
	Items    []Member `json:"items"`
	NextLink string   `json:"nextLink"`
}

A list of Members belonging to a particular Tenant.

type PermissionList added in v1.11.0

type PermissionList struct {
	Items    []string `json:"items"`
	NextLink string   `json:"nextLink"`
}

A list of permissions.

type PermissionString added in v1.8.0

type PermissionString string

type Principal

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

type PrincipalKind

type PrincipalKind string

PrincipalKind :

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

List of PrincipalKind

type PrincipalList added in v1.11.0

type PrincipalList struct {
	Items    []Principal `json:"items"`
	NextLink string      `json:"nextLink"`
}

A list of Principals.

type PrincipalProfile

type PrincipalProfile struct {
	Email     *string `json:"email,omitempty"`
	FirstName *string `json:"firstName,omitempty"`
	FullName  *string `json:"fullName,omitempty"`
	LastName  *string `json:"lastName,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 {
	Name        string   `json:"name"`
	CreatedAt   *string  `json:"createdAt,omitempty"`
	CreatedBy   *string  `json:"createdBy,omitempty"`
	Permissions []string `json:"permissions,omitempty"`
	Tenant      *string  `json:"tenant,omitempty"`
}

type RoleList added in v1.11.0

type RoleList struct {
	Items    []Role `json:"items"`
	NextLink string `json:"nextLink"`
}

A list of role.

type RolePermission

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

type RolePermissionList added in v1.11.0

type RolePermissionList struct {
	Items    []RolePermission `json:"items"`
	NextLink string           `json:"nextLink"`
}

A list of role permissions.

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, addRolePermissionBody AddRolePermissionBody, resp ...*http.Response) (*RolePermission, error)

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

role: The role name.
addRolePermissionBody: 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) CreatePrincipal added in v1.11.0

func (s *Service) CreatePrincipal(createPrincipalBody CreatePrincipalBody, query *CreatePrincipalQueryParams, resp ...*http.Response) (*Principal, error)

CreatePrincipal - identity service endpoint Create a new principal Parameters:

createPrincipalBody: The new principal to add to the system.
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) 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 and any relevant profile information. 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, query *ListGroupMembersQueryParams, resp ...*http.Response) (*GroupMemberList, error)

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

group: The group 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) ListGroupRoles

func (s *Service) ListGroupRoles(group string, query *ListGroupRolesQueryParams, resp ...*http.Response) (*GroupRoleList, 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.
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) ListGroups

func (s *Service) ListGroups(query *ListGroupsQueryParams, resp ...*http.Response) (*GroupList, 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, query *ListMemberGroupsQueryParams, resp ...*http.Response) (*GroupList, error)

ListMemberGroups - identity service endpoint Returns a list of groups that a member belongs to within a 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) ListMemberPermissions

func (s *Service) ListMemberPermissions(member string, query *ListMemberPermissionsQueryParams, resp ...*http.Response) (*PermissionList, 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, query *ListMemberRolesQueryParams, resp ...*http.Response) (*RoleList, error)

ListMemberRoles - identity service endpoint Returns a set of roles that a given member holds 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) ListMembers

func (s *Service) ListMembers(query *ListMembersQueryParams, resp ...*http.Response) (*MemberList, error)

ListMembers - identity service endpoint Returns a list of members 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) ListPrincipals

func (s *Service) ListPrincipals(query *ListPrincipalsQueryParams, resp ...*http.Response) (*PrincipalList, error)

ListPrincipals - identity service endpoint Returns the list of principals that the Identity service knows about. 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) ListRoleGroups

func (s *Service) ListRoleGroups(role string, query *ListRoleGroupsQueryParams, resp ...*http.Response) (*GroupList, error)

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

role: The role 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) ListRolePermissions

func (s *Service) ListRolePermissions(role string, query *ListRolePermissionsQueryParams, resp ...*http.Response) (*RolePermissionList, error)

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

role: The role 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) ListRoles

func (s *Service) ListRoles(query *ListRolesQueryParams, resp ...*http.Response) (*RoleList, error)

ListRoles - identity service endpoint Returns all roles for 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) 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 access 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.
			addRolePermissionBody: 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, addRolePermissionBody AddRolePermissionBody, 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)
	/*
		CreatePrincipal - identity service endpoint
		Create a new principal
		Parameters:
			createPrincipalBody: The new principal to add to the system.
			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
	*/
	CreatePrincipal(createPrincipalBody CreatePrincipalBody, query *CreatePrincipalQueryParams, resp ...*http.Response) (*Principal, 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 and any relevant profile information.
		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.
			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
	*/
	ListGroupMembers(group string, query *ListGroupMembersQueryParams, resp ...*http.Response) (*GroupMemberList, 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.
			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
	*/
	ListGroupRoles(group string, query *ListGroupRolesQueryParams, resp ...*http.Response) (*GroupRoleList, 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) (*GroupList, error)
	/*
		ListMemberGroups - identity service endpoint
		Returns a list of groups that a member belongs to within a 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
	*/
	ListMemberGroups(member string, query *ListMemberGroupsQueryParams, resp ...*http.Response) (*GroupList, 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) (*PermissionList, error)
	/*
		ListMemberRoles - identity service endpoint
		Returns a set of roles that a given member holds 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
	*/
	ListMemberRoles(member string, query *ListMemberRolesQueryParams, resp ...*http.Response) (*RoleList, error)
	/*
		ListMembers - identity service endpoint
		Returns a list of members 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
	*/
	ListMembers(query *ListMembersQueryParams, resp ...*http.Response) (*MemberList, error)
	/*
		ListPrincipals - identity service endpoint
		Returns the list of principals that the Identity service knows about.
		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
	*/
	ListPrincipals(query *ListPrincipalsQueryParams, resp ...*http.Response) (*PrincipalList, error)
	/*
		ListRoleGroups - identity service endpoint
		Gets a list of groups for a role in a given tenant.
		Parameters:
			role: The role 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
	*/
	ListRoleGroups(role string, query *ListRoleGroupsQueryParams, resp ...*http.Response) (*GroupList, error)
	/*
		ListRolePermissions - identity service endpoint
		Gets the permissions for a role in a given tenant.
		Parameters:
			role: The role 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
	*/
	ListRolePermissions(role string, query *ListRolePermissionsQueryParams, resp ...*http.Response) (*RolePermissionList, error)
	/*
		ListRoles - identity service endpoint
		Returns all roles for 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
	*/
	ListRoles(query *ListRolesQueryParams, resp ...*http.Response) (*RoleList, 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 access 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 {
	Name          string        `json:"name"`
	CreatedAt     *string       `json:"createdAt,omitempty"`
	CreatedBy     *string       `json:"createdBy,omitempty"`
	Status        *TenantStatus `json:"status,omitempty"`
	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