IAdmAzureManagedDomain

The IAdmAzureManagedDomain interface represents a Microsoft Entra domain managed by Adaxes.

Inheritance: IAdmManagedDomain

Methods

  • Method

  • Description

  • ValidateServiceAccount()

  • Checks whether an app registration can be used to manage the Microsoft Entra domain.

  • Register()

  • Registers a Microsoft Entra domain in Adaxes or changes the app credentials if the domain is already managed.

  • GetDefaultLocation()

  • Returns the distinguished name (DN) of the organizational unit where objects of the specified type created outside of Adaxes are placed.

  • SetDefaultLocation()

  • Sets the distinguished name (DN) of the organizational unit where to place objects of the specified type created outside of Adaxes.

Properties

Details

ValidateServiceAccount()

Checks whether an app registration can be used to manage the Microsoft Entra domain. If the app registration can be used to manage the domain, but it doesn't have required permissions, the method throws the DirectoryComException exception with error code ERROR_NO_SUCH_PRIVILEGE.

void ValidateServiceAccount(string tenantId,
                            string applicationId,
                            string secret,
                            AzureNationalCloud nationalCloud)

Parameters

  • tenantId – Specifies the identifier of the Microsoft Entra tenant.
  • applicationId – Specifies the identifier of the app registration.
  • secret – Specifies the client secret of the app registration.
  • nationalCloud – Specifies the Microsoft Entra national cloud.

Register()

Registers a Microsoft Entra domain in Adaxes or changes the app credentials if the domain is already managed.

void Register(string tenantId,
              string applicationId,
              string secret,
              AzureNationalCloud nationalCloud)

Parameters

  • tenantId – Specifies the identifier of the Microsoft Entra tenant.
  • applicationId – Specifies the identifier of the app registration.
  • secret – Specifies the client secret of the app registration.
  • nationalCloud – Specifies the Microsoft Entra national cloud.

GetDefaultLocation()

Returns the distinguished name (DN) of the organizational unit where objects of the specified type created outside of Adaxes are placed.

string GetDefaultLocation(string objectType)

Parameters

The objectType parameter specifies the type of objects to return the organizational unit DN for. Allowed values are users, groups and resources.

SetDefaultLocation()

Sets the distinguished name (DN) of the organizational unit where to place objects of the specified type created outside of Adaxes.

void SetDefaultLocation(string objectType, string containerDN)

Parameters

  • objectType – Specifies the type of objects to set the organizational unit DN for. Allowed values are users, groups and resources.
  • containerDN – Specifies the distinguished name (DN) of the organizational unit to set. For details on how to get the DN of a directory object, see Get the DN of a directory object.

Remarks

To propagate the changes to the directory, call IADs::SetInfo after calling SetDefaultLocation.

TenantId

Gets the identifier of the Microsoft Entra tenant.

  • Type:
  • Guid
  • Access:
  • Read-only

TenantName

Gets the name of the Microsoft Entra tenant.

  • Type:
  • string
  • Access:
  • Read-only

NationalCloud

Gets the Microsoft Entra national cloud.

SyncDataIntervalSec

Gets or sets the interval (in seconds) for how frequently to check if the Microsoft Entra ID cache needs to be updated.

  • Type:
  • int
  • Access:
  • Read/Write

SyncedObjectManagementOptions

Gets or sets the IAdmDomainSyncedObjectManagementOptions interface used to manage options for displaying objects synchronized with Active Directory.

LastSyncTime

Gets the timestamp when the last check for updates of Microsoft Entra resources was performed.

  • Type:
  • IADsLargeInteger
  • Access:
  • Read-only

LastSyncUpdateTime

Gets the time when the Microsoft Entra ID cache was last updated.

  • Type:
  • IADsLargeInteger
  • Access:
  • Read-only

Requirements

Minimum required version: 2023

See also

© Softerra 2022. All rights reserved.
Send feedback