Class ProjectPolicyAdminApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

ProjectPolicyAdminApi

Implements

IProjectPolicyAdminApi

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Apis.Admin.AccessPolicy

Assembly: Unity.Services.Apis.dll

Syntax

public class ProjectPolicyAdminApi : IProjectPolicyAdminApi, IApiAccessor

Constructors

ProjectPolicyAdminApi(IApiClient)

Initializes a new instance of the ProjectPolicyAdminApi class using a Configuration object and client instance.

Declaration

public ProjectPolicyAdminApi(IApiClient apiClient)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.

ProjectPolicyAdminApi(IApiClient, IApiConfiguration)

Initializes a new instance of the ProjectPolicyAdminApi class using a Configuration object and client instance.

Declaration

public ProjectPolicyAdminApi(IApiClient apiClient, IApiConfiguration apiConfiguration)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.
IApiConfiguration	apiConfiguration	The configuration object.

Properties

Client

The client for accessing this underlying API asynchronously.

Declaration

public IApiClient Client { get; }

Property Value

Type	Description
IApiClient

Configuration

Gets the configuration object

Declaration

public IApiConfiguration Configuration { get; }

Property Value

Type	Description
IApiConfiguration	An instance of the Configuration

Methods

DeletePolicyStatements(string, string, DeleteOptions, CancellationToken)

Delete policy statement(s) Delete policy statement(s) for project-based policy.

Declaration

public ApiOperation DeletePolicyStatements(string projectId, string environmentId, DeleteOptions deleteOptions, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project
string	environmentId	ID of the environment
DeleteOptions	deleteOptions
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetPolicy(string, string, CancellationToken)

Get a project based policy A policy consists of multiple policy statements. This endpoint will return a Policy object containing an array of all non-expired policy statements in that policy.

Declaration

public ApiOperation<Policy> GetPolicy(string projectId, string environmentId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project
string	environmentId	ID of the environment
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<Policy>	The operation

UpsertPolicy(string, string, Policy, CancellationToken)

Create or update a project based policy Create or update a project based policy. A maximum of 500 non-expired statements per policy can be created/updated.

Declaration

public ApiOperation UpsertPolicy(string projectId, string environmentId, Policy policy, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project
string	environmentId	ID of the environment
Policy	policy
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

Implements

IProjectPolicyAdminApi

IApiAccessor