Documentation
¶
Overview ¶
Package graph exposes the Azure DevOps Graph/Identity service: users, groups and subject memberships. All operations are read-only and reach the vssps.dev.azure.com host using preview API endpoints.
Index ¶
Constants ¶
const Name = "graph"
Name is the toolset name used for enable/disable filtering.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Descriptor ¶
type Descriptor struct {
Value string `json:"value,omitempty"`
}
Descriptor resolves a storage key to its subject descriptor value.
type GetDescriptorInput ¶
type GetDescriptorInput struct {
StorageKey string `json:"storageKey" jsonschema:"the storage key (subject id) to resolve to a graph descriptor"`
}
GetDescriptorInput selects the storage key to resolve.
type GraphGroup ¶
type GraphGroup struct {
SubjectKind string `json:"subjectKind,omitempty"`
DisplayName string `json:"displayName,omitempty"`
PrincipalName string `json:"principalName,omitempty"`
Description string `json:"description,omitempty"`
Descriptor string `json:"descriptor,omitempty"`
}
GraphGroup is a group subject in the organization's graph.
type GraphUser ¶
type GraphUser struct {
SubjectKind string `json:"subjectKind,omitempty"`
DisplayName string `json:"displayName,omitempty"`
PrincipalName string `json:"principalName,omitempty"`
MailAddress string `json:"mailAddress,omitempty"`
Descriptor string `json:"descriptor,omitempty"`
Origin string `json:"origin,omitempty"`
}
GraphUser is a user subject in the organization's graph.
type ListGroupsInput ¶ added in v0.1.2
type ListGroupsInput struct {
SubjectTypes string `json:"subjectTypes,omitempty" jsonschema:"comma-separated list of subject type filters, e.g. 'aad,vsts' (optional)"`
ContinuationToken string `` /* 131-byte string literal not displayed */
}
ListGroupsInput filters and pages the group subjects list.
type ListMembershipsInput ¶
type ListMembershipsInput struct {
SubjectDescriptor string `json:"subjectDescriptor" jsonschema:"the descriptor of the subject (user or group) whose memberships are listed"`
Direction string `json:"direction,omitempty" jsonschema:"traversal direction: 'up' for containers, 'down' for members (optional)"`
}
ListMembershipsInput selects the subject and optional traversal direction.
type ListUsersInput ¶ added in v0.1.2
type ListUsersInput struct {
SubjectTypes string `json:"subjectTypes,omitempty" jsonschema:"comma-separated list of subject type filters, e.g. 'aad,vsts' (optional)"`
ContinuationToken string `` /* 131-byte string literal not displayed */
}
ListUsersInput filters and pages the user subjects list.
type Membership ¶
type Membership struct {
ContainerDescriptor string `json:"containerDescriptor,omitempty"`
MemberDescriptor string `json:"memberDescriptor,omitempty"`
}
Membership is a relationship between a member subject and its container.
type MembershipInput ¶
type MembershipInput struct {
SubjectDescriptor string `json:"subjectDescriptor" jsonschema:"the descriptor of the member subject (user or group)"`
ContainerDescriptor string `json:"containerDescriptor" jsonschema:"the descriptor of the container group"`
}
MembershipInput identifies the subject and container of a membership.
Source Files