Interface IServicePrincipal

Manage the SharePoint apps service principal

Namespace: PnP.Core.Admin.Model.SharePoint

Assembly: PnP.Core.Admin.dll

Syntax

public interface IServicePrincipal

Methods

AddGrant(String, String, VanityUrlOptions)

Grants a Permission

Declaration

IPermissionGrant AddGrant(string resource, string scope, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String resource Resource of the permission

System.String scope Scope of the permission

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

IPermissionGrant the new permission grant

AddGrant2(String, String, VanityUrlOptions)

Grants scope on a resource

Declaration

IPermissionGrant2 AddGrant2(string resource, string scope, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String resource The name of the resource, e.g. Microsoft Graph

System.String scope The scope to grant, e.g. 'User.ReadBasic.All'

VanityUrlOptions vanityUrlOptions

Returns

IPermissionGrant2 The resulting IPermissionGrant2

AddGrant2Async(String, String, VanityUrlOptions)

Grants scope on a resource

Declaration

Task<IPermissionGrant2> AddGrant2Async(string resource, string scope, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String resource The name of the resource, e.g. Microsoft Graph

System.String scope The scope to grant, e.g. 'User.ReadBasic.All'

VanityUrlOptions vanityUrlOptions

Returns

Task<IPermissionGrant2> The resulting IPermissionGrant2

AddGrantAsync(String, String, VanityUrlOptions)

Grants a Permission

Declaration

Task<IPermissionGrant> AddGrantAsync(string resource, string scope, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String resource Resource of the permission

System.String scope Scope of the permission

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

Task<IPermissionGrant> the new permission grant

ApprovePermissionRequest(String, VanityUrlOptions)

Approves the specified permission request

Declaration

IPermissionGrant ApprovePermissionRequest(string id, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String id permission request id

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

IPermissionGrant permission grant

ApprovePermissionRequestAsync(String, VanityUrlOptions)

Approves the specified permission request

Declaration

Task<IPermissionGrant> ApprovePermissionRequestAsync(string id, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String id permission request id

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

Task<IPermissionGrant> permission grant

DeleteGrant2(String, VanityUrlOptions)

Deletes the whole grant with all scopes.

Declaration

void DeleteGrant2(string grantId, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String grantId The id of the grant

VanityUrlOptions vanityUrlOptions

DeleteGrant2Async(String, VanityUrlOptions)

Deletes the whole grant with all scopes.

Declaration

Task DeleteGrant2Async(string grantId, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String grantId The id of the grant

VanityUrlOptions vanityUrlOptions

Returns

Task void

DenyPermissionRequest(String, VanityUrlOptions)

Denies the specified permission request

Declaration

void DenyPermissionRequest(string id, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String id permission request id

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

DenyPermissionRequestAsync(String, VanityUrlOptions)

Denies the specified permission request

Declaration

Task DenyPermissionRequestAsync(string id, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String id permission request id

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

Task

Disable(VanityUrlOptions)

Disable the Service Principal

Declaration

IServicePrincipalProperties Disable(VanityUrlOptions vanityUrlOptions = null)

Parameters

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

IServicePrincipalProperties the list of permission requests

Disable2(VanityUrlOptions)

Disable the Service Principal

Declaration

IServicePrincipalProperties Disable2(VanityUrlOptions vanityUrlOptions = null)

Parameters

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

IServicePrincipalProperties the list of permission requests

Disable2Async(VanityUrlOptions)

Disable the Service Principal

Declaration

Task<IServicePrincipalProperties> Disable2Async(VanityUrlOptions vanityUrlOptions = null)

Parameters

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

Task<IServicePrincipalProperties> the list of permission requests

DisableAsync(VanityUrlOptions)

Disable the Service Principal

Declaration

Task<IServicePrincipalProperties> DisableAsync(VanityUrlOptions vanityUrlOptions = null)

Parameters

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

Task<IServicePrincipalProperties> the list of permission requests

Enable(VanityUrlOptions)

Enable the Service Principal

Declaration

IServicePrincipalProperties Enable(VanityUrlOptions vanityUrlOptions = null)

Parameters

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

IServicePrincipalProperties the list of permission requests

Enable2(VanityUrlOptions)

Enable the Service Principal

Declaration

IServicePrincipalProperties Enable2(VanityUrlOptions vanityUrlOptions = null)

Parameters

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

IServicePrincipalProperties the list of permission requests

Enable2Async(VanityUrlOptions)

Enable the Service Principal

Declaration

Task<IServicePrincipalProperties> Enable2Async(VanityUrlOptions vanityUrlOptions = null)

Parameters

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

Task<IServicePrincipalProperties> the list of permission requests

EnableAsync(VanityUrlOptions)

Enable the Service Principal

Declaration

Task<IServicePrincipalProperties> EnableAsync(VanityUrlOptions vanityUrlOptions = null)

Parameters

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

Task<IServicePrincipalProperties> the list of permission requests

GetPermissionRequests(VanityUrlOptions)

Lists pending permission requests

Declaration

List<IPermissionRequest> GetPermissionRequests(VanityUrlOptions vanityUrlOptions = null)

Parameters

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

List<IPermissionRequest> the list of permission requests

GetPermissionRequestsAsync(VanityUrlOptions)

Lists pending permission requests

Declaration

Task<List<IPermissionRequest>> GetPermissionRequestsAsync(VanityUrlOptions vanityUrlOptions = null)

Parameters

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

Task<List<IPermissionRequest>> the list of permission requests

ListGrants(VanityUrlOptions)

Lists all granted Permissions

Declaration

IEnumerable<IPermissionGrant> ListGrants(VanityUrlOptions vanityUrlOptions = null)

Parameters

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

IEnumerable<IPermissionGrant> the list of granted permissions

ListGrants2(VanityUrlOptions)

Get all granted permissions of the SharePoint Online Client Extensibility Web Application Principal

Declaration

IPermissionGrant2[] ListGrants2(VanityUrlOptions vanityUrlOptions = null)

Parameters

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

IPermissionGrant2[] The list of granted OAuth2 permissions

ListGrants2Async(VanityUrlOptions)

Get all granted permissions of the SharePoint Online Client Extensibility Web Application Principal

Declaration

Task<IPermissionGrant2[]> ListGrants2Async(VanityUrlOptions vanityUrlOptions = null)

Parameters

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

Task<IPermissionGrant2[]> The list of granted OAuth2 permissions

ListGrantsAsync(VanityUrlOptions)

Lists all granted Permissions

Declaration

Task<IEnumerable<IPermissionGrant>> ListGrantsAsync(VanityUrlOptions vanityUrlOptions = null)

Parameters

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

Task<IEnumerable<IPermissionGrant>> the list of granted permissions

RevokeGrant(String, VanityUrlOptions)

Revokes a Permission

Declaration

IPermissionGrant RevokeGrant(string objectId, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String objectId Object Id of the permission

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

IPermissionGrant the revoked permission grant

RevokeGrant2(String, String, VanityUrlOptions)

Removed a scope from an existing grant

Declaration

IPermissionGrant2 RevokeGrant2(string grantId, string scope, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String grantId The id of the grant

System.String scope The scope to remove from the grant denoted by grantId

VanityUrlOptions vanityUrlOptions

Returns

IPermissionGrant2 The updated IPermissionGrant2, or null if the last scope was removed from the grant

RevokeGrant2Async(String, String, VanityUrlOptions)

Removed a scope from an existing grant

Declaration

Task<IPermissionGrant2> RevokeGrant2Async(string grantId, string scope, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String grantId The id of the grant

System.String scope The scope to remove from the grant denoted by grantId

VanityUrlOptions vanityUrlOptions

Returns

Task<IPermissionGrant2> The updated IPermissionGrant2, or null if the last scope was removed from the grant

RevokeGrantAsync(String, VanityUrlOptions)

Revokes a Permission

Declaration

Task<IPermissionGrant> RevokeGrantAsync(string objectId, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String objectId Object Id of the permission

VanityUrlOptions vanityUrlOptions Optionally specify the custom vanity URI's used by this tenant

Returns

Task<IPermissionGrant> the revoked permission grant