GraphScopeCreationContext interface

Package:

azure-devops-extension-api

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.

Properties

adminGroupDescription	Set this field to override the default description of this scope's admin group.
adminGroupName	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.
creatorId	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.
name	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.
scopeType	The type of scope being created.
storageKey	An optional ID that uniquely represents the scope within it's parent scope. If this parameter is not provided, Vsts will generate on automatically.

Property Details

adminGroupDescription

Set this field to override the default description of this scope's admin group.

adminGroupDescription: string

Property Value

string

adminGroupName

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

Property Value

string

creatorId

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: string

Property Value

string

name

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

Property Value

string

scopeType

The type of scope being created.

scopeType: GroupScopeType

Property Value

GroupScopeType

storageKey

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: string

Property Value

string