graph

package
v1.0.0-b5 Latest Latest
Warning

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

 Go to latest Published: Aug 23, 2020 License: MIT Imports: 12 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var GraphMemberSearchFactorValues = graphMemberSearchFactorValuesType{

	PrincipalName: "principalName",

	DisplayName: "displayName",

	AdministratorsGroup: "administratorsGroup",

	Identifier: "identifier",

	MailAddress: "mailAddress",

	General: "general",

	Alias: "alias",

	DirectoryAlias: "directoryAlias",
}
View Source 
var GraphTraversalDirectionValues = graphTraversalDirectionValuesType{
	Unknown: "unknown",
	Down:    "down",
	Up:      "up",
}
View Source 
var ResourceAreaId, _ = uuid.Parse("bb1e7ec9-e901-4b68-999a-de7012b920f8")

Functions

This section is empty.

Types

type AddMembershipArgs 

type AddMembershipArgs struct {
	// (required) A descriptor to a group or user that can be the child subject in the relationship.
	SubjectDescriptor *string
	// (required) A descriptor to a group that can be the container in the relationship.
	ContainerDescriptor *string
}

Arguments for the AddMembership function

type CheckMembershipExistenceArgs 

type CheckMembershipExistenceArgs struct {
	// (required) The group or user that is a child subject of the relationship.
	SubjectDescriptor *string
	// (required) The group that is the container in the relationship.
	ContainerDescriptor *string
}

Arguments for the CheckMembershipExistence function

type Client 

type Client interface {
	// [Preview API] Create a new membership between a container and subject.
	AddMembership(context.Context, AddMembershipArgs) (*GraphMembership, error)
	// [Preview API] Check to see if a membership relationship between a container and subject exists.
	CheckMembershipExistence(context.Context, CheckMembershipExistenceArgs) error
	// [Preview API] Create a new Azure DevOps group or materialize an existing AAD group.
	CreateGroup(context.Context, CreateGroupArgs) (*GraphGroup, error)
	// [Preview API] Materialize an existing AAD or MSA user into the VSTS account.
	CreateUser(context.Context, CreateUserArgs) (*GraphUser, error)
	// [Preview API]
	DeleteAvatar(context.Context, DeleteAvatarArgs) error
	// [Preview API] Removes an Azure DevOps group from all of its parent groups.
	DeleteGroup(context.Context, DeleteGroupArgs) error
	// [Preview API] Disables a user.
	DeleteUser(context.Context, DeleteUserArgs) error
	// [Preview API]
	GetAvatar(context.Context, GetAvatarArgs) (*profile.Avatar, error)
	// [Preview API] Resolve a storage key to a descriptor
	GetDescriptor(context.Context, GetDescriptorArgs) (*GraphDescriptorResult, error)
	// [Preview API] Get a group by its descriptor.
	GetGroup(context.Context, GetGroupArgs) (*GraphGroup, error)
	// [Preview API] Get a membership relationship between a container and subject.
	GetMembership(context.Context, GetMembershipArgs) (*GraphMembership, error)
	// [Preview API] Check whether a subject is active or inactive.
	GetMembershipState(context.Context, GetMembershipStateArgs) (*GraphMembershipState, error)
	// [Preview API]
	GetProviderInfo(context.Context, GetProviderInfoArgs) (*GraphProviderInfo, error)
	// [Preview API] Resolve a descriptor to a storage key.
	GetStorageKey(context.Context, GetStorageKeyArgs) (*GraphStorageKeyResult, error)
	// [Preview API] Get a user by its descriptor.
	GetUser(context.Context, GetUserArgs) (*GraphUser, error)
	// [Preview API] Gets a list of all groups in the current scope (usually organization or account).
	ListGroups(context.Context, ListGroupsArgs) (*PagedGraphGroups, error)
	// [Preview API] Get all the memberships where this descriptor is a member in the relationship.
	ListMemberships(context.Context, ListMembershipsArgs) (*[]GraphMembership, error)
	// [Preview API] Get a list of all users in a given scope.
	ListUsers(context.Context, ListUsersArgs) (*PagedGraphUsers, error)
	// [Preview API] Resolve descriptors to users, groups or scopes (Subjects) in a batch.
	LookupSubjects(context.Context, LookupSubjectsArgs) (*map[string]GraphSubject, error)
	// [Preview API] Deletes a membership between a container and subject.
	RemoveMembership(context.Context, RemoveMembershipArgs) error
	// [Preview API]
	RequestAccess(context.Context, RequestAccessArgs) error
	// [Preview API]
	SetAvatar(context.Context, SetAvatarArgs) error
	// [Preview API] Update the properties of an Azure DevOps group.
	UpdateGroup(context.Context, UpdateGroupArgs) (*GraphGroup, error)
	// [Preview API] Map an existing user to a different identity
	UpdateUser(context.Context, UpdateUserArgs) (*GraphUser, error)
}

func NewClient 

func NewClient(ctx context.Context, connection *azuredevops.Connection) (Client, error)

type ClientImpl 

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) AddMembership 

func (client *ClientImpl) AddMembership(ctx context.Context, args AddMembershipArgs) (*GraphMembership, error)

[Preview API] Create a new membership between a container and subject.

func (*ClientImpl) CheckMembershipExistence 

func (client *ClientImpl) CheckMembershipExistence(ctx context.Context, args CheckMembershipExistenceArgs) error

[Preview API] Check to see if a membership relationship between a container and subject exists.

func (*ClientImpl) CreateGroup 

func (client *ClientImpl) CreateGroup(ctx context.Context, args CreateGroupArgs) (*GraphGroup, error)

[Preview API] Create a new Azure DevOps group or materialize an existing AAD group.

func (*ClientImpl) CreateUser 

func (client *ClientImpl) CreateUser(ctx context.Context, args CreateUserArgs) (*GraphUser, error)

[Preview API] Materialize an existing AAD or MSA user into the VSTS account.

func (*ClientImpl) DeleteAvatar 

func (client *ClientImpl) DeleteAvatar(ctx context.Context, args DeleteAvatarArgs) error

[Preview API]

func (*ClientImpl) DeleteGroup 

func (client *ClientImpl) DeleteGroup(ctx context.Context, args DeleteGroupArgs) error

[Preview API] Removes an Azure DevOps group from all of its parent groups.

func (*ClientImpl) DeleteUser 

func (client *ClientImpl) DeleteUser(ctx context.Context, args DeleteUserArgs) error

[Preview API] Disables a user.

func (*ClientImpl) GetAvatar 

func (client *ClientImpl) GetAvatar(ctx context.Context, args GetAvatarArgs) (*profile.Avatar, error)

[Preview API]

func (*ClientImpl) GetDescriptor 

func (client *ClientImpl) GetDescriptor(ctx context.Context, args GetDescriptorArgs) (*GraphDescriptorResult, error)

[Preview API] Resolve a storage key to a descriptor

func (*ClientImpl) GetGroup 

func (client *ClientImpl) GetGroup(ctx context.Context, args GetGroupArgs) (*GraphGroup, error)

[Preview API] Get a group by its descriptor.

func (*ClientImpl) GetMembership 

func (client *ClientImpl) GetMembership(ctx context.Context, args GetMembershipArgs) (*GraphMembership, error)

[Preview API] Get a membership relationship between a container and subject.

func (*ClientImpl) GetMembershipState 

func (client *ClientImpl) GetMembershipState(ctx context.Context, args GetMembershipStateArgs) (*GraphMembershipState, error)

[Preview API] Check whether a subject is active or inactive.

func (*ClientImpl) GetProviderInfo 

func (client *ClientImpl) GetProviderInfo(ctx context.Context, args GetProviderInfoArgs) (*GraphProviderInfo, error)

[Preview API]

func (*ClientImpl) GetStorageKey 

func (client *ClientImpl) GetStorageKey(ctx context.Context, args GetStorageKeyArgs) (*GraphStorageKeyResult, error)

[Preview API] Resolve a descriptor to a storage key.

func (*ClientImpl) GetUser 

func (client *ClientImpl) GetUser(ctx context.Context, args GetUserArgs) (*GraphUser, error)

[Preview API] Get a user by its descriptor.

func (*ClientImpl) ListGroups 

func (client *ClientImpl) ListGroups(ctx context.Context, args ListGroupsArgs) (*PagedGraphGroups, error)

[Preview API] Gets a list of all groups in the current scope (usually organization or account).

func (*ClientImpl) ListMemberships 

func (client *ClientImpl) ListMemberships(ctx context.Context, args ListMembershipsArgs) (*[]GraphMembership, error)

[Preview API] Get all the memberships where this descriptor is a member in the relationship.

func (*ClientImpl) ListUsers 

func (client *ClientImpl) ListUsers(ctx context.Context, args ListUsersArgs) (*PagedGraphUsers, error)

[Preview API] Get a list of all users in a given scope.

func (*ClientImpl) LookupSubjects 

func (client *ClientImpl) LookupSubjects(ctx context.Context, args LookupSubjectsArgs) (*map[string]GraphSubject, error)

[Preview API] Resolve descriptors to users, groups or scopes (Subjects) in a batch.

func (*ClientImpl) RemoveMembership 

func (client *ClientImpl) RemoveMembership(ctx context.Context, args RemoveMembershipArgs) error

[Preview API] Deletes a membership between a container and subject.

func (*ClientImpl) RequestAccess 

func (client *ClientImpl) RequestAccess(ctx context.Context, args RequestAccessArgs) error

[Preview API]

func (*ClientImpl) SetAvatar 

func (client *ClientImpl) SetAvatar(ctx context.Context, args SetAvatarArgs) error

[Preview API]

func (*ClientImpl) UpdateGroup 

func (client *ClientImpl) UpdateGroup(ctx context.Context, args UpdateGroupArgs) (*GraphGroup, error)

[Preview API] Update the properties of an Azure DevOps group.

func (*ClientImpl) UpdateUser 

func (client *ClientImpl) UpdateUser(ctx context.Context, args UpdateUserArgs) (*GraphUser, error)

[Preview API] Map an existing user to a different identity

type CreateGroupArgs 

type CreateGroupArgs struct {
	// (required) The subset of the full graph group used to uniquely find the graph subject in an external provider.
	CreationContext *GraphGroupCreationContext
	// (optional) A descriptor referencing the scope (collection, project) in which the group should be created. If omitted, will be created in the scope of the enclosing account or organization. Valid only for VSTS groups.
	ScopeDescriptor *string
	// (optional) A comma separated list of descriptors referencing groups you want the graph group to join
	GroupDescriptors *[]string
}

Arguments for the CreateGroup function

type CreateUserArgs 

type CreateUserArgs struct {
	// (required) The subset of the full graph user used to uniquely find the graph subject in an external provider.
	CreationContext *GraphUserCreationContext
	// (optional) A comma separated list of descriptors of groups you want the graph user to join
	GroupDescriptors *[]string
}

Arguments for the CreateUser function

type DeleteAvatarArgs 

type DeleteAvatarArgs struct {
	// (required)
	SubjectDescriptor *string
}

Arguments for the DeleteAvatar function

type DeleteGroupArgs 

type DeleteGroupArgs struct {
	// (required) The descriptor of the group to delete.
	GroupDescriptor *string
}

Arguments for the DeleteGroup function

type DeleteUserArgs 

type DeleteUserArgs struct {
	// (required) The descriptor of the user to delete.
	UserDescriptor *string
}

Arguments for the DeleteUser function

type GetAvatarArgs 

type GetAvatarArgs struct {
	// (required)
	SubjectDescriptor *string
	// (optional)
	Size *profile.AvatarSize
	// (optional)
	Format *string
}

Arguments for the GetAvatar function

type GetDescriptorArgs 

type GetDescriptorArgs struct {
	// (required) Storage key of the subject (user, group, scope, etc.) to resolve
	StorageKey *uuid.UUID
}

Arguments for the GetDescriptor function

type GetGroupArgs 

type GetGroupArgs struct {
	// (required) The descriptor of the desired graph group.
	GroupDescriptor *string
}

Arguments for the GetGroup function

type GetMembershipArgs 

type GetMembershipArgs struct {
	// (required) A descriptor to the child subject in the relationship.
	SubjectDescriptor *string
	// (required) A descriptor to the container in the relationship.
	ContainerDescriptor *string
}

Arguments for the GetMembership function

type GetMembershipStateArgs 

type GetMembershipStateArgs struct {
	// (required) Descriptor of the subject (user, group, scope, etc.) to check state of
	SubjectDescriptor *string
}

Arguments for the GetMembershipState function

type GetProviderInfoArgs 

type GetProviderInfoArgs struct {
	// (required)
	UserDescriptor *string
}

Arguments for the GetProviderInfo function

type GetStorageKeyArgs 

type GetStorageKeyArgs struct {
	// (required)
	SubjectDescriptor *string
}

Arguments for the GetStorageKey function

type GetUserArgs 

type GetUserArgs struct {
	// (required) The descriptor of the desired user.
	UserDescriptor *string
}

Arguments for the GetUser function

type GraphCachePolicies 

type GraphCachePolicies struct {
	// Size of the cache
	CacheSize *int `json:"cacheSize,omitempty"`
}

type GraphDescriptorResult 

type GraphDescriptorResult struct {
	// This field contains zero or more interesting links about the graph descriptor. These links may be invoked to obtain additional relationships or more detailed information about this graph descriptor.
	Links interface{} `json:"_links,omitempty"`
	Value *string     `json:"value,omitempty"`
}

Subject descriptor of a Graph entity

type GraphGlobalExtendedPropertyBatch 

type GraphGlobalExtendedPropertyBatch struct {
	PropertyNameFilters *[]string `json:"propertyNameFilters,omitempty"`
	SubjectDescriptors  *[]string `json:"subjectDescriptors,omitempty"`
}

type GraphGroup 

type GraphGroup struct {
	// This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
	Links interface{} `json:"_links,omitempty"`
	// The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
	Descriptor *string `json:"descriptor,omitempty"`
	// This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
	DisplayName *string `json:"displayName,omitempty"`
	// This url is the full route to the source resource of this graph subject.
	Url *string `json:"url,omitempty"`
	// [Internal Use Only] The legacy descriptor is here in case you need to access old version IMS using identity descriptor.
	LegacyDescriptor *string `json:"legacyDescriptor,omitempty"`
	// The type of source provider for the origin identifier (ex:AD, AAD, MSA)
	Origin *string `json:"origin,omitempty"`
	// The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider.
	OriginId *string `json:"originId,omitempty"`
	// This field identifies the type of the graph subject (ex: Group, Scope, User).
	SubjectKind *string `json:"subjectKind,omitempty"`
	// This represents the name of the container of origin for a graph member. (For MSA this is "Windows Live ID", for AD the name of the domain, for AAD the tenantID of the directory, for VSTS groups the ScopeId, etc)
	Domain *string `json:"domain,omitempty"`
	// The email address of record for a given graph member. This may be different than the principal name.
	MailAddress *string `json:"mailAddress,omitempty"`
	// This is the PrincipalName of this graph member from the source provider. The source provider may change this field over time and it is not guaranteed to be immutable for the life of the graph member by VSTS.
	PrincipalName *string `json:"principalName,omitempty"`
	// A short phrase to help human readers disambiguate groups with similar names
	Description *string `json:"description,omitempty"`
}

Graph group entity

type GraphGroupCreationContext 

type GraphGroupCreationContext struct {
	// Optional: If provided, we will use this identifier for the storage key of the created group
	StorageKey *uuid.UUID `json:"storageKey,omitempty"`
}

Do not attempt to use this type to create a new group. This type does not contain sufficient fields to create a new group.

type GraphGroupMailAddressCreationContext 

type GraphGroupMailAddressCreationContext struct {
	// Optional: If provided, we will use this identifier for the storage key of the created group
	StorageKey *uuid.UUID `json:"storageKey,omitempty"`
	// This should be the mail address or the group in the source AD or AAD provider. Example: jamal@contoso.com Team Services will communicate with the source provider to fill all other fields on creation.
	MailAddress *string `json:"mailAddress,omitempty"`
}

Use this type to create a new group using the mail address as a reference to an existing group from an external AD or AAD backed provider. This is the subset of GraphGroup fields required for creation of a group for the AAD and AD use case.

type GraphGroupOriginIdCreationContext 

type GraphGroupOriginIdCreationContext struct {
	// Optional: If provided, we will use this identifier for the storage key of the created group
	StorageKey *uuid.UUID `json:"storageKey,omitempty"`
	// This should be the object id or sid of the group from the source AD or AAD provider. Example: d47d025a-ce2f-4a79-8618-e8862ade30dd Team Services will communicate with the source provider to fill all other fields on creation.
	OriginId *string `json:"originId,omitempty"`
}

Use this type to create a new group using the OriginID as a reference to an existing group from an external AD or AAD backed provider. This is the subset of GraphGroup fields required for creation of a group for the AD and AAD use case.

type GraphGroupVstsCreationContext 

type GraphGroupVstsCreationContext struct {
	// Optional: If provided, we will use this identifier for the storage key of the created group
	StorageKey *uuid.UUID `json:"storageKey,omitempty"`
	// For internal use only in back compat scenarios.
	CrossProject *bool `json:"crossProject,omitempty"`
	// Used by VSTS groups; if set this will be the group description, otherwise ignored
	Description *string `json:"description,omitempty"`
	Descriptor  *string `json:"descriptor,omitempty"`
	// Used by VSTS groups; if set this will be the group DisplayName, otherwise ignored
	DisplayName *string `json:"displayName,omitempty"`
	// For internal use only in back compat scenarios.
	RestrictedVisibility *bool `json:"restrictedVisibility,omitempty"`
	// For internal use only in back compat scenarios.
	SpecialGroupType *string `json:"specialGroupType,omitempty"`
}

Use this type to create a new Vsts group that is not backed by an external provider.

type GraphMember 

type GraphMember struct {
	// This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
	Links interface{} `json:"_links,omitempty"`
	// The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
	Descriptor *string `json:"descriptor,omitempty"`
	// This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
	DisplayName *string `json:"displayName,omitempty"`
	// This url is the full route to the source resource of this graph subject.
	Url *string `json:"url,omitempty"`
	// [Internal Use Only] The legacy descriptor is here in case you need to access old version IMS using identity descriptor.
	LegacyDescriptor *string `json:"legacyDescriptor,omitempty"`
	// The type of source provider for the origin identifier (ex:AD, AAD, MSA)
	Origin *string `json:"origin,omitempty"`
	// The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider.
	OriginId *string `json:"originId,omitempty"`
	// This field identifies the type of the graph subject (ex: Group, Scope, User).
	SubjectKind *string `json:"subjectKind,omitempty"`
	// This represents the name of the container of origin for a graph member. (For MSA this is "Windows Live ID", for AD the name of the domain, for AAD the tenantID of the directory, for VSTS groups the ScopeId, etc)
	Domain *string `json:"domain,omitempty"`
	// The email address of record for a given graph member. This may be different than the principal name.
	MailAddress *string `json:"mailAddress,omitempty"`
	// This is the PrincipalName of this graph member from the source provider. The source provider may change this field over time and it is not guaranteed to be immutable for the life of the graph member by VSTS.
	PrincipalName *string `json:"principalName,omitempty"`
}

type GraphMemberSearchFactor 

type GraphMemberSearchFactor string

type GraphMembership 

type GraphMembership struct {
	// This field contains zero or more interesting links about the graph membership. These links may be invoked to obtain additional relationships or more detailed information about this graph membership.
	Links               interface{} `json:"_links,omitempty"`
	ContainerDescriptor *string     `json:"containerDescriptor,omitempty"`
	MemberDescriptor    *string     `json:"memberDescriptor,omitempty"`
}

Relationship between a container and a member

type GraphMembershipState 

type GraphMembershipState struct {
	// This field contains zero or more interesting links about the graph membership state. These links may be invoked to obtain additional relationships or more detailed information about this graph membership state.
	Links interface{} `json:"_links,omitempty"`
	// When true, the membership is active
	Active *bool `json:"active,omitempty"`
}

Status of a Graph membership (active/inactive)

type GraphMembershipTraversal 

type GraphMembershipTraversal struct {
	// Reason why the subject could not be traversed completely
	IncompletenessReason *string `json:"incompletenessReason,omitempty"`
	// When true, the subject is traversed completely
	IsComplete *bool `json:"isComplete,omitempty"`
	// The traversed subject descriptor
	SubjectDescriptor *string `json:"subjectDescriptor,omitempty"`
	// Subject descriptor ids of the traversed members
	TraversedSubjectIds *[]uuid.UUID `json:"traversedSubjectIds,omitempty"`
	// Subject descriptors of the traversed members
	TraversedSubjects *[]string `json:"traversedSubjects,omitempty"`
}

type GraphProviderInfo 

type GraphProviderInfo struct {
	// The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
	Descriptor *string `json:"descriptor,omitempty"`
	// This represents the name of the container of origin for a graph member. (For MSA this is "Windows Live ID", for AAD the tenantID of the directory.)
	Domain *string `json:"domain,omitempty"`
	// The type of source provider for the origin identifier (ex: "aad", "msa")
	Origin *string `json:"origin,omitempty"`
	// The unique identifier from the system of origin. (For MSA this is the PUID in hex notation, for AAD this is the object id.)
	OriginId *string `json:"originId,omitempty"`
}

Who is the provider for this user and what is the identifier and domain that is used to uniquely identify the user.

type GraphScope 

type GraphScope struct {
	// This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
	Links interface{} `json:"_links,omitempty"`
	// The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
	Descriptor *string `json:"descriptor,omitempty"`
	// This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
	DisplayName *string `json:"displayName,omitempty"`
	// This url is the full route to the source resource of this graph subject.
	Url *string `json:"url,omitempty"`
	// [Internal Use Only] The legacy descriptor is here in case you need to access old version IMS using identity descriptor.
	LegacyDescriptor *string `json:"legacyDescriptor,omitempty"`
	// The type of source provider for the origin identifier (ex:AD, AAD, MSA)
	Origin *string `json:"origin,omitempty"`
	// The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider.
	OriginId *string `json:"originId,omitempty"`
	// This field identifies the type of the graph subject (ex: Group, Scope, User).
	SubjectKind *string `json:"subjectKind,omitempty"`
	// The subject descriptor that references the administrators group for this scope. Only members of this group can change the contents of this scope or assign other users permissions to access this scope.
	AdministratorDescriptor *string `json:"administratorDescriptor,omitempty"`
	// When true, this scope is also a securing host for one or more scopes.
	IsGlobal *bool `json:"isGlobal,omitempty"`
	// The subject descriptor for the closest account or organization in the ancestor tree of this scope.
	ParentDescriptor *string `json:"parentDescriptor,omitempty"`
	// The type of this scope. Typically ServiceHost or TeamProject.
	ScopeType *identity.GroupScopeType `json:"scopeType,omitempty"`
	// The subject descriptor for the containing organization in the ancestor tree of this scope.
	SecuringHostDescriptor *string `json:"securingHostDescriptor,omitempty"`
}

Container where a graph entity is defined (organization, project, team)

type GraphScopeCreationContext 

type GraphScopeCreationContext struct {
	// Set this field to override the default description of this scope's admin group.
	AdminGroupDescription *string `json:"adminGroupDescription,omitempty"`
	// All scopes have an Administrator Group that controls access to the contents of the scope. Set this field to use a non-default group name for that administrators group.
	AdminGroupName *string `json:"adminGroupName,omitempty"`
	// Set this optional field if this scope is created on behalf of a user other than the user making the request. This should be the Id of the user that is not the requester.
	CreatorId *uuid.UUID `json:"creatorId,omitempty"`
	// The scope must be provided with a unique name within the parent scope. This means the created scope can have a parent or child with the same name, but no siblings with the same name.
	Name *string `json:"name,omitempty"`
	// The type of scope being created.
	ScopeType *identity.GroupScopeType `json:"scopeType,omitempty"`
	// An optional ID that uniquely represents the scope within it's parent scope. If this parameter is not provided, Vsts will generate on automatically.
	StorageKey *uuid.UUID `json:"storageKey,omitempty"`
}

This type is the subset of fields that can be provided by the user to create a Vsts scope. Scope creation is currently limited to internal back-compat scenarios. End users that attempt to create a scope with this API will fail.

type GraphStorageKeyResult 

type GraphStorageKeyResult struct {
	// This field contains zero or more interesting links about the graph storage key. These links may be invoked to obtain additional relationships or more detailed information about this graph storage key.
	Links interface{} `json:"_links,omitempty"`
	Value *uuid.UUID  `json:"value,omitempty"`
}

Storage key of a Graph entity

type GraphSubject 

type GraphSubject struct {
	// This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
	Links interface{} `json:"_links,omitempty"`
	// The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
	Descriptor *string `json:"descriptor,omitempty"`
	// This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
	DisplayName *string `json:"displayName,omitempty"`
	// This url is the full route to the source resource of this graph subject.
	Url *string `json:"url,omitempty"`
	// [Internal Use Only] The legacy descriptor is here in case you need to access old version IMS using identity descriptor.
	LegacyDescriptor *string `json:"legacyDescriptor,omitempty"`
	// The type of source provider for the origin identifier (ex:AD, AAD, MSA)
	Origin *string `json:"origin,omitempty"`
	// The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider.
	OriginId *string `json:"originId,omitempty"`
	// This field identifies the type of the graph subject (ex: Group, Scope, User).
	SubjectKind *string `json:"subjectKind,omitempty"`
}

Top-level graph entity

type GraphSubjectBase 

type GraphSubjectBase struct {
	// This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
	Links interface{} `json:"_links,omitempty"`
	// The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
	Descriptor *string `json:"descriptor,omitempty"`
	// This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
	DisplayName *string `json:"displayName,omitempty"`
	// This url is the full route to the source resource of this graph subject.
	Url *string `json:"url,omitempty"`
}

type GraphSubjectLookup 

type GraphSubjectLookup struct {
	LookupKeys *[]GraphSubjectLookupKey `json:"lookupKeys,omitempty"`
}

Batching of subjects to lookup using the Graph API

type GraphSubjectLookupKey 

type GraphSubjectLookupKey struct {
	Descriptor *string `json:"descriptor,omitempty"`
}

type GraphSystemSubject 

type GraphSystemSubject struct {
	// This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
	Links interface{} `json:"_links,omitempty"`
	// The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
	Descriptor *string `json:"descriptor,omitempty"`
	// This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
	DisplayName *string `json:"displayName,omitempty"`
	// This url is the full route to the source resource of this graph subject.
	Url *string `json:"url,omitempty"`
	// [Internal Use Only] The legacy descriptor is here in case you need to access old version IMS using identity descriptor.
	LegacyDescriptor *string `json:"legacyDescriptor,omitempty"`
	// The type of source provider for the origin identifier (ex:AD, AAD, MSA)
	Origin *string `json:"origin,omitempty"`
	// The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider.
	OriginId *string `json:"originId,omitempty"`
	// This field identifies the type of the graph subject (ex: Group, Scope, User).
	SubjectKind *string `json:"subjectKind,omitempty"`
}

type GraphTraversalDirection 

type GraphTraversalDirection string

type GraphUser 

type GraphUser struct {
	// This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
	Links interface{} `json:"_links,omitempty"`
	// The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
	Descriptor *string `json:"descriptor,omitempty"`
	// This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
	DisplayName *string `json:"displayName,omitempty"`
	// This url is the full route to the source resource of this graph subject.
	Url *string `json:"url,omitempty"`
	// [Internal Use Only] The legacy descriptor is here in case you need to access old version IMS using identity descriptor.
	LegacyDescriptor *string `json:"legacyDescriptor,omitempty"`
	// The type of source provider for the origin identifier (ex:AD, AAD, MSA)
	Origin *string `json:"origin,omitempty"`
	// The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider.
	OriginId *string `json:"originId,omitempty"`
	// This field identifies the type of the graph subject (ex: Group, Scope, User).
	SubjectKind *string `json:"subjectKind,omitempty"`
	// This represents the name of the container of origin for a graph member. (For MSA this is "Windows Live ID", for AD the name of the domain, for AAD the tenantID of the directory, for VSTS groups the ScopeId, etc)
	Domain *string `json:"domain,omitempty"`
	// The email address of record for a given graph member. This may be different than the principal name.
	MailAddress *string `json:"mailAddress,omitempty"`
	// This is the PrincipalName of this graph member from the source provider. The source provider may change this field over time and it is not guaranteed to be immutable for the life of the graph member by VSTS.
	PrincipalName *string `json:"principalName,omitempty"`
	// The short, generally unique name for the user in the backing directory. For AAD users, this corresponds to the mail nickname, which is often but not necessarily similar to the part of the user's mail address before the @ sign. For GitHub users, this corresponds to the GitHub user handle.
	DirectoryAlias *string `json:"directoryAlias,omitempty"`
	// When true, the group has been deleted in the identity provider
	IsDeletedInOrigin *bool `json:"isDeletedInOrigin,omitempty"`
	// The meta type of the user in the origin, such as "member", "guest", etc. See UserMetaType for the set of possible values.
	MetaType *string `json:"metaType,omitempty"`
}

Graph user entity

type GraphUserCreationContext 

type GraphUserCreationContext struct {
	// Optional: If provided, we will use this identifier for the storage key of the created user
	StorageKey *uuid.UUID `json:"storageKey,omitempty"`
}

Do not attempt to use this type to create a new user. Use one of the subclasses instead. This type does not contain sufficient fields to create a new user.

type GraphUserMailAddressCreationContext 

type GraphUserMailAddressCreationContext struct {
	// Optional: If provided, we will use this identifier for the storage key of the created user
	StorageKey  *uuid.UUID `json:"storageKey,omitempty"`
	MailAddress *string    `json:"mailAddress,omitempty"`
}

Use this type to create a new user using the mail address as a reference to an existing user from an external AD or AAD backed provider. This is the subset of GraphUser fields required for creation of a GraphUser for the AD and AAD use case when looking up the user by its mail address in the backing provider.

type GraphUserOriginIdCreationContext 

type GraphUserOriginIdCreationContext struct {
	// Optional: If provided, we will use this identifier for the storage key of the created user
	StorageKey *uuid.UUID `json:"storageKey,omitempty"`
	// This should be the name of the origin provider. Example: github.com
	Origin *string `json:"origin,omitempty"`
	// This should be the object id or sid of the user from the source AD or AAD provider. Example: d47d025a-ce2f-4a79-8618-e8862ade30dd Team Services will communicate with the source provider to fill all other fields on creation.
	OriginId *string `json:"originId,omitempty"`
}

Use this type to create a new user using the OriginID as a reference to an existing user from an external AD or AAD backed provider. This is the subset of GraphUser fields required for creation of a GraphUser for the AD and AAD use case when looking up the user by its unique ID in the backing provider.

type GraphUserOriginIdUpdateContext 

type GraphUserOriginIdUpdateContext struct {
	// Storage key should not be specified in case of updating user
	StorageKey *uuid.UUID `json:"storageKey,omitempty"`
	// This should be the object id or sid of the user from the source AD or AAD provider. Example: d47d025a-ce2f-4a79-8618-e8862ade30dd Azure Devops will communicate with the source provider to fill all other fields on creation.
	OriginId *string `json:"originId,omitempty"`
}

Use this type to update an existing user using the OriginID as a reference to an existing user from an external AD or AAD backed provider. This is the subset of GraphUser fields required for creation of a GraphUser for the AD and AAD use case when looking up the user by its unique ID in the backing provider.

type GraphUserPrincipalNameCreationContext 

type GraphUserPrincipalNameCreationContext struct {
	// Optional: If provided, we will use this identifier for the storage key of the created user
	StorageKey *uuid.UUID `json:"storageKey,omitempty"`
	// This should be the principal name or upn of the user in the source AD or AAD provider. Example: jamal@contoso.com Team Services will communicate with the source provider to fill all other fields on creation.
	PrincipalName *string `json:"principalName,omitempty"`
}

Use this type to create a new user using the principal name as a reference to an existing user from an external AD or AAD backed provider. This is the subset of GraphUser fields required for creation of a GraphUser for the AD and AAD use case when looking up the user by its principal name in the backing provider.

type GraphUserUpdateContext 

type GraphUserUpdateContext struct {
	// Deprecated:
	StorageKey *uuid.UUID `json:"storageKey,omitempty"`
}

Do not attempt to use this type to update user. Use one of the subclasses instead. This type does not contain sufficient fields to create a new user.

type ListGroupsArgs 

type ListGroupsArgs struct {
	// (optional) Specify a non-default scope (collection, project) to search for groups.
	ScopeDescriptor *string
	// (optional) A comma separated list of user subject subtypes to reduce the retrieved results, e.g. Microsoft.IdentityModel.Claims.ClaimsIdentity
	SubjectTypes *[]string
	// (optional) An opaque data blob that allows the next page of data to resume immediately after where the previous page ended. The only reliable way to know if there is more data left is the presence of a continuation token.
	ContinuationToken *string
}

Arguments for the ListGroups function

type ListMembershipsArgs 

type ListMembershipsArgs struct {
	// (required) Fetch all direct memberships of this descriptor.
	SubjectDescriptor *string
	// (optional) Defaults to Up.
	Direction *GraphTraversalDirection
	// (optional) The maximum number of edges to traverse up or down the membership tree. Currently the only supported value is '1'.
	Depth *int
}

Arguments for the ListMemberships function

type ListUsersArgs 

type ListUsersArgs struct {
	// (optional) A comma separated list of user subject subtypes to reduce the retrieved results, e.g. msa’, ‘aad’, ‘svc’ (service identity), ‘imp’ (imported identity), etc.
	SubjectTypes *[]string
	// (optional) An opaque data blob that allows the next page of data to resume immediately after where the previous page ended. The only reliable way to know if there is more data left is the presence of a continuation token.
	ContinuationToken *string
}

Arguments for the ListUsers function

type LookupSubjectsArgs 

type LookupSubjectsArgs struct {
	// (required) A list of descriptors that specifies a subset of subjects to retrieve. Each descriptor uniquely identifies the subject across all instance scopes, but only at a single point in time.
	SubjectLookup *GraphSubjectLookup
}

Arguments for the LookupSubjects function

type PagedGraphGroups 

type PagedGraphGroups struct {
	// This will be non-null if there is another page of data. There will never be more than one continuation token returned by a request.
	ContinuationToken *[]string `json:"continuationToken,omitempty"`
	// The enumerable list of groups found within a page.
	GraphGroups *[]GraphGroup `json:"graphGroups,omitempty"`
}

type PagedGraphUsers 

type PagedGraphUsers struct {
	// This will be non-null if there is another page of data. There will never be more than one continuation token returned by a request.
	ContinuationToken *[]string `json:"continuationToken,omitempty"`
	// The enumerable set of users found within a page.
	GraphUsers *[]GraphUser `json:"graphUsers,omitempty"`
}

type RemoveMembershipArgs 

type RemoveMembershipArgs struct {
	// (required) A descriptor to a group or user that is the child subject in the relationship.
	SubjectDescriptor *string
	// (required) A descriptor to a group that is the container in the relationship.
	ContainerDescriptor *string
}

Arguments for the RemoveMembership function

type RequestAccessArgs 

type RequestAccessArgs struct {
	// (required)
	Message *string
}

Arguments for the RequestAccess function

type SetAvatarArgs 

type SetAvatarArgs struct {
	// (required)
	Avatar *profile.Avatar
	// (required)
	SubjectDescriptor *string
}

Arguments for the SetAvatar function

type UpdateGroupArgs 

type UpdateGroupArgs struct {
	// (required) The descriptor of the group to modify.
	GroupDescriptor *string
	// (required) The JSON+Patch document containing the fields to alter.
	PatchDocument *[]webapi.JsonPatchOperation
}

Arguments for the UpdateGroup function

type UpdateUserArgs 

type UpdateUserArgs struct {
	// (required) The subset of the full graph user used to uniquely find the graph subject in an external provider.
	UpdateContext *GraphUserUpdateContext
	// (required) the descriptor of the user to update
	UserDescriptor *string
}

Arguments for the UpdateUser function

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.