Skip to main content

Data import

Connection details​

ParameterDescription
Base URLhttps://api.omada.cloud
Authentication typeAPI Key
API KeyX-API-Key
API Key valueAPI Key Value
Test connectionSelect the checkbox.

Queries and mappings​

Users - Accounts​

Parameters:

TabParameterValue
GeneralURL/users?api-version=2022-01-01
GeneralDistinctYes
GeneralEnabledSelect the checkbox
AdvancedHTTP verbGET
AdvancedURL is a DynamicExpresso expressionNo

Mappings:

DestinationOperatorSource
Business keyMapid
Unique IDMapemail
Account nameMapemail
Display nameExpressionString.Format("{0}, {1}", lastName, firstName)
StatusConstantActive

Entitlement - Resource​

Parameters:

TabParameterValue
GeneralURL/users?api-version=2022-01-01
GeneralDistinctYes
GeneralEnabledSelect the checkbox
AdvancedHTTP verbGET
AdvancedURL is a DynamicExpresso expressionNo

Mappings:

DestinationOperatorSource
Business keyExpressionString.Format("{0}_{1}", id, "CustomerAdmin")
Security resource business keyExpressionString.Format("{0}_{1}", id, "CustomerAdmin")
Name  ExpressionString.Format("{0} ({1})", "CustomerAdmin", details_name)
Category  ConstantPermission
TypeConstantOmada Identity Cloud Management Platform Entitlement
Display nameExpressionString.Format(„{0} ({1})", „CustomerAdmin", details_name)
Short nameExpressionString.Format(„{0} ({1})", „CustomerAdmin", details_name)

Entitlement - Resource Assignment​

Parameters:

TabParameterValue
GeneralURL/customers?includeTerminated=false&api-version=2022-01-01
GeneralEnabledSelect the checkbox
AdvancedHTTP verbGET
AdvancedURL is a DynamicExpresso expressionNo
Nested requestNested URL/users?role=CustomerAdmin&scope={PARENT_id}&api-version=2022-01-01
Nested requestChange PagingYes
Nested requesthttp 404 Not Found Error HandlingTerminate import
Nested requestPage MechanismNone

Mappings:

DestinationOperatorSource
Resource business keyExpressionString.Format("{0}_{1}", PARENT_id, "CustomerAdmin")
Account - business keyMapid

Account rules​

Ownership rule​

The account owner is set to the identity, where the Email value of the identity matches the Account UID value of the account.

FieldValue
TypeIdentity lookup
Join reasonExact Match
Account attributeAccount UID
Identity attributeEmail

Classification rule​

If an account with the account attribute Identity join reason equals Exact Match, the account type is set to Personal.

FieldValue
Account typePersonal
Scope attributeIdentity join reason
Scope operatorEquals
Scope valueExact Match