Class OrganizationClient
Service client instance for Organization.
Implements
Inherited Members
Namespace: Oci.TenantmanagercontrolplaneService
Assembly: OCI.DotNetSDK.Tenantmanagercontrolplane.dll
Syntax
public class OrganizationClient : RegionalClientBase, IDisposable
Constructors
OrganizationClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public OrganizationClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public OrganizationPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
OrganizationPaginators |
Waiters
Declaration
public OrganizationWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
OrganizationWaiters |
Methods
ApproveOrganizationTenancyForTransfer(ApproveOrganizationTenancyForTransferRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Approve an organization's child tenancy for transfer.
Declaration
public Task<ApproveOrganizationTenancyForTransferResponse> ApproveOrganizationTenancyForTransfer(ApproveOrganizationTenancyForTransferRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ApproveOrganizationTenancyForTransferRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ApproveOrganizationTenancyForTransferResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ApproveOrganizationTenancyForTransfer API.
CreateChildTenancy(CreateChildTenancyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a child tenancy asynchronously.
Declaration
public Task<CreateChildTenancyResponse> CreateChildTenancy(CreateChildTenancyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateChildTenancyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateChildTenancyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateChildTenancy API.
DeleteOrganizationTenancy(DeleteOrganizationTenancyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
If certain validations are successful, initiate tenancy termination.
Declaration
public Task<DeleteOrganizationTenancyResponse> DeleteOrganizationTenancy(DeleteOrganizationTenancyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteOrganizationTenancyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteOrganizationTenancyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteOrganizationTenancy API.
GetOrganization(GetOrganizationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about the organization.
Declaration
public Task<GetOrganizationResponse> GetOrganization(GetOrganizationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetOrganizationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetOrganizationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetOrganization API.
GetOrganizationTenancy(GetOrganizationTenancyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about the organization's tenancy.
Declaration
public Task<GetOrganizationTenancyResponse> GetOrganizationTenancy(GetOrganizationTenancyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetOrganizationTenancyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetOrganizationTenancyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetOrganizationTenancy API.
ListOrganizationTenancies(ListOrganizationTenanciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of tenancies in the organization.
Declaration
public Task<ListOrganizationTenanciesResponse> ListOrganizationTenancies(ListOrganizationTenanciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOrganizationTenanciesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOrganizationTenanciesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOrganizationTenancies API.
ListOrganizations(ListOrganizationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists organizations associated with the caller.
Declaration
public Task<ListOrganizationsResponse> ListOrganizations(ListOrganizationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOrganizationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOrganizationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOrganizations API.
RestoreOrganizationTenancy(RestoreOrganizationTenancyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
An asynchronous API to restore a tenancy.
Declaration
public Task<RestoreOrganizationTenancyResponse> RestoreOrganizationTenancy(RestoreOrganizationTenancyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RestoreOrganizationTenancyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RestoreOrganizationTenancyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RestoreOrganizationTenancy API.
UnapproveOrganizationTenancyForTransfer(UnapproveOrganizationTenancyForTransferRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cancel an organization's child tenancy for transfer.
Declaration
public Task<UnapproveOrganizationTenancyForTransferResponse> UnapproveOrganizationTenancyForTransfer(UnapproveOrganizationTenancyForTransferRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UnapproveOrganizationTenancyForTransferRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UnapproveOrganizationTenancyForTransferResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UnapproveOrganizationTenancyForTransfer API.
UpdateOrganization(UpdateOrganizationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Map the default subscription to the organization.
Declaration
public Task<UpdateOrganizationResponse> UpdateOrganization(UpdateOrganizationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateOrganizationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateOrganizationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateOrganization API.