Module microsoft.dynamics365.finance.users

ballerinax/microsoft.dynamics365.finance.users Ballerina library

0.8.0

Overview

Microsoft Dynamics 365 Finance is Microsoft's cloud ERP solution for financial management, covering general ledger, accounts receivable and payable, fixed assets, budgeting, cash and bank management, and tax.

The microsoft.dynamics365.finance.users connector provides access to Microsoft Dynamics 365 Finance Users entities via the OData REST API.

Key Features

Manage users entities in Microsoft Dynamics 365 Finance
Support for list, create, read, update, and delete operations
OAuth2 client credentials authentication

Setup guide

Prerequisites

A Microsoft Dynamics 365 Finance & Operations environment (cloud-hosted or sandbox)
An Azure Active Directory (Entra ID) app registration with API permissions for Dynamics 365

Step 1: Register an application in Azure AD

Sign in to the Azure portal and navigate to Azure Active Directory → App registrations → New registration.
Give the application a name, select the appropriate account type, and click Register.
Note the Application (client) ID and Directory (tenant) ID from the overview page.
Under Certificates & secrets, create a new client secret and note the value immediately — it is only shown once.

Step 2: Grant Dynamics 365 API permissions

In the app registration, go to API permissions → Add a permission → APIs my organization uses.
Search for Dynamics 365 (or Microsoft Dynamics ERP) and add the user_impersonation (or .default) delegated/application scope.
Click Grant admin consent for your tenant.

Step 3: Add the app as a D365 user

In your D365 Finance environment, go to System administration → Users → New.
Set the User ID and User name, then paste the Azure AD Application (client) ID into the Azure AD application field.
Assign appropriate security roles and save.

Quickstart

To use the microsoft.dynamics365.finance.users connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import the module


import ballerinax/microsoft.dynamics365.finance.users;

Step 2: Instantiate a new connector


configurable string tenantId = ?;
configurable string clientId = ?;
configurable string clientSecret = ?;
configurable string serviceUrl = ?;   // e.g. "https://<env>.operations.dynamics.com/data"

users:Client cl = check new ({
    config = {
        auth: {
            tokenUrl: string `https://login.microsoftonline.com/${tenantId}/oauth2/v2.0/token`,
            clientId,
            clientSecret,
            scopes: [string `${serviceUrl}/.default`]
        }
    },
    serviceUrl
);

Step 3: Invoke the connector operation


users:ChannelUsersCollection results = check cl->listChannelUsers();

Step 4: Run the Ballerina application


bal run

Examples

The Dynamics 365 Finance Ballerina connectors provide practical examples illustrating usage in various scenarios. Explore these examples.

Clients

microsoft.dynamics365.finance.users: Client

Isolated

Constructor

Gets invoked to initialize the connector.

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector

serviceUrl string "https://your-org.operations.dynamics.com/data" - URL of the target service

listChannelUsers

Isolated FunctionRemote Function

function listChannelUsers(map<string|string[]> headers, *ListChannelUsersQueries queries) returns ChannelUsersCollection|error

List ChannelUsers

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListChannelUsersQueries - Queries to be sent with the request

Return Type

ChannelUsersCollection|error - Collection of ChannelUser

createChannelUsers

Isolated FunctionRemote Function

function createChannelUsers(ChannelUser payload, map<string|string[]> headers) returns ChannelUser|error

Create ChannelUser

Parameters

payload ChannelUser - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ChannelUser|error - ChannelUser created

getChannelUsers

Isolated FunctionRemote Function

function getChannelUsers(string dataAreaId, string operatingUnitNumber, string user, map<string|string[]> headers, *GetChannelUsersQueries queries) returns ChannelUser|error

Get ChannelUser by key

Parameters

dataAreaId string - The company data area identifier

operatingUnitNumber string - The operating unit number key field

user string - The user key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetChannelUsersQueries - Queries to be sent with the request

Return Type

ChannelUser|error - ChannelUser

deleteChannelUsers

Isolated FunctionRemote Function

function deleteChannelUsers(string dataAreaId, string operatingUnitNumber, string user, DeleteChannelUsersHeaders headers) returns error?

Delete ChannelUser

Parameters

dataAreaId string - The company data area identifier

operatingUnitNumber string - The operating unit number key field

user string - The user key field

headers DeleteChannelUsersHeaders (default {}) - Headers to be sent with the request

Return Type

error? - ChannelUser deleted

updateChannelUsers

Isolated FunctionRemote Function

function updateChannelUsers(string dataAreaId, string operatingUnitNumber, string user, ChannelUser payload, UpdateChannelUsersHeaders headers) returns ChannelUser|error

Update ChannelUser

Parameters

dataAreaId string - The company data area identifier

operatingUnitNumber string - The operating unit number key field

user string - The user key field

payload ChannelUser - The request body

headers UpdateChannelUsersHeaders (default {}) - Headers to be sent with the request

Return Type

ChannelUser|error - ChannelUser updated

listExternalRoles

Isolated FunctionRemote Function

function listExternalRoles(map<string|string[]> headers, *ListExternalRolesQueries queries) returns ExternalRolesCollection|error

List ExternalRoles

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListExternalRolesQueries - Queries to be sent with the request

Return Type

ExternalRolesCollection|error - Collection of ExternalRole

createExternalRoles

Isolated FunctionRemote Function

function createExternalRoles(ExternalRole payload, map<string|string[]> headers) returns ExternalRole|error

Create ExternalRole

Parameters

payload ExternalRole - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ExternalRole|error - ExternalRole created

getExternalRoles

Isolated FunctionRemote Function

function getExternalRoles(string role, string 'type, map<string|string[]> headers, *GetExternalRolesQueries queries) returns ExternalRole|error

Get ExternalRole by key

Parameters

role string - The role key field

'type string - The entity type identifier

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetExternalRolesQueries - Queries to be sent with the request

Return Type

ExternalRole|error - ExternalRole

deleteExternalRoles

Isolated FunctionRemote Function

function deleteExternalRoles(string role, string 'type, DeleteExternalRolesHeaders headers) returns error?

Delete ExternalRole

Parameters

role string - The role key field

'type string - The entity type identifier

headers DeleteExternalRolesHeaders (default {}) - Headers to be sent with the request

Return Type

error? - ExternalRole deleted

updateExternalRoles

Isolated FunctionRemote Function

function updateExternalRoles(string role, string 'type, ExternalRole payload, UpdateExternalRolesHeaders headers) returns ExternalRole|error

Update ExternalRole

Parameters

role string - The role key field

'type string - The entity type identifier

payload ExternalRole - The request body

headers UpdateExternalRolesHeaders (default {}) - Headers to be sent with the request

Return Type

ExternalRole|error - ExternalRole updated

listGroups

Isolated FunctionRemote Function

function listGroups(map<string|string[]> headers, *ListGroupsQueries queries) returns GroupsCollection|error

List Groups

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListGroupsQueries - Queries to be sent with the request

Return Type

GroupsCollection|error - Collection of Group

createGroups

Isolated FunctionRemote Function

function createGroups(Group payload, map<string|string[]> headers) returns Group|error

Create Group

Parameters

payload Group - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Group|error - Group created

getGroups

Isolated FunctionRemote Function

function getGroups(string dataAreaId, string deferralsGroup, map<string|string[]> headers, *GetGroupsQueries queries) returns Group|error

Get Group by key

Parameters

dataAreaId string - The company data area identifier

deferralsGroup string - The deferrals group key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetGroupsQueries - Queries to be sent with the request

Return Type

Group|error - Group

deleteGroups

Isolated FunctionRemote Function

function deleteGroups(string dataAreaId, string deferralsGroup, DeleteGroupsHeaders headers) returns error?

Delete Group

Parameters

dataAreaId string - The company data area identifier

deferralsGroup string - The deferrals group key field

headers DeleteGroupsHeaders (default {}) - Headers to be sent with the request

Return Type

error? - Group deleted

updateGroups

Isolated FunctionRemote Function

function updateGroups(string dataAreaId, string deferralsGroup, Group payload, UpdateGroupsHeaders headers) returns Group|error

Update Group

Parameters

dataAreaId string - The company data area identifier

deferralsGroup string - The deferrals group key field

payload Group - The request body

headers UpdateGroupsHeaders (default {}) - Headers to be sent with the request

Return Type

Group|error - Group updated

listSecurityRoles

Isolated FunctionRemote Function

function listSecurityRoles(map<string|string[]> headers, *ListSecurityRolesQueries queries) returns SecurityRolesCollection|error

List SecurityRoles

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListSecurityRolesQueries - Queries to be sent with the request

Return Type

SecurityRolesCollection|error - Collection of SecurityRole

createSecurityRoles

Isolated FunctionRemote Function

function createSecurityRoles(SecurityRole payload, map<string|string[]> headers) returns SecurityRole|error

Create SecurityRole

Parameters

payload SecurityRole - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SecurityRole|error - SecurityRole created

getSecurityRoles

Isolated FunctionRemote Function

function getSecurityRoles(string securityRoleIdentifier, map<string|string[]> headers, *GetSecurityRolesQueries queries) returns SecurityRole|error

Get SecurityRole by key

Parameters

securityRoleIdentifier string - The security role identifier key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetSecurityRolesQueries - Queries to be sent with the request

Return Type

SecurityRole|error - SecurityRole

deleteSecurityRoles

Isolated FunctionRemote Function

function deleteSecurityRoles(string securityRoleIdentifier, DeleteSecurityRolesHeaders headers) returns error?

Delete SecurityRole

Parameters

securityRoleIdentifier string - The security role identifier key field

headers DeleteSecurityRolesHeaders (default {}) - Headers to be sent with the request

Return Type

error? - SecurityRole deleted

updateSecurityRoles

Isolated FunctionRemote Function

function updateSecurityRoles(string securityRoleIdentifier, SecurityRole payload, UpdateSecurityRolesHeaders headers) returns SecurityRole|error

Update SecurityRole

Parameters

securityRoleIdentifier string - The security role identifier key field

payload SecurityRole - The request body

headers UpdateSecurityRolesHeaders (default {}) - Headers to be sent with the request

Return Type

SecurityRole|error - SecurityRole updated

listSourceSystems

Isolated FunctionRemote Function

function listSourceSystems(map<string|string[]> headers, *ListSourceSystemsQueries queries) returns SourceSystemsCollection|error

List SourceSystems

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListSourceSystemsQueries - Queries to be sent with the request

Return Type

SourceSystemsCollection|error - Collection of SourceSystem

createSourceSystems

Isolated FunctionRemote Function

function createSourceSystems(SourceSystem payload, map<string|string[]> headers) returns SourceSystem|error

Create SourceSystem

Parameters

payload SourceSystem - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SourceSystem|error - SourceSystem created

getSourceSystems

Isolated FunctionRemote Function

function getSourceSystems(string name, map<string|string[]> headers, *GetSourceSystemsQueries queries) returns SourceSystem|error

Get SourceSystem by key

Parameters

name string - The name key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetSourceSystemsQueries - Queries to be sent with the request

Return Type

SourceSystem|error - SourceSystem

deleteSourceSystems

Isolated FunctionRemote Function

function deleteSourceSystems(string name, DeleteSourceSystemsHeaders headers) returns error?

Delete SourceSystem

Parameters

name string - The name key field

headers DeleteSourceSystemsHeaders (default {}) - Headers to be sent with the request

Return Type

error? - SourceSystem deleted

updateSourceSystems

Isolated FunctionRemote Function

function updateSourceSystems(string name, SourceSystem payload, UpdateSourceSystemsHeaders headers) returns SourceSystem|error

Update SourceSystem

Parameters

name string - The name key field

payload SourceSystem - The request body

headers UpdateSourceSystemsHeaders (default {}) - Headers to be sent with the request

Return Type

SourceSystem|error - SourceSystem updated

listSourceTypes

Isolated FunctionRemote Function

function listSourceTypes(map<string|string[]> headers, *ListSourceTypesQueries queries) returns SourceTypesCollection|error

List SourceTypes

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListSourceTypesQueries - Queries to be sent with the request

Return Type

SourceTypesCollection|error - Collection of SourceType

createSourceTypes

Isolated FunctionRemote Function

function createSourceTypes(SourceType payload, map<string|string[]> headers) returns SourceType|error

Create SourceType

Parameters

payload SourceType - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SourceType|error - SourceType created

getSourceTypes

Isolated FunctionRemote Function

function getSourceTypes(string dataAreaId, string sourceTypeId, map<string|string[]> headers, *GetSourceTypesQueries queries) returns SourceType|error

Get SourceType by key

Parameters

dataAreaId string - The company data area identifier

sourceTypeId string - The source type id key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetSourceTypesQueries - Queries to be sent with the request

Return Type

SourceType|error - SourceType

deleteSourceTypes

Isolated FunctionRemote Function

function deleteSourceTypes(string dataAreaId, string sourceTypeId, DeleteSourceTypesHeaders headers) returns error?

Delete SourceType

Parameters

dataAreaId string - The company data area identifier

sourceTypeId string - The source type id key field

headers DeleteSourceTypesHeaders (default {}) - Headers to be sent with the request

Return Type

error? - SourceType deleted

updateSourceTypes

Isolated FunctionRemote Function

function updateSourceTypes(string dataAreaId, string sourceTypeId, SourceType payload, UpdateSourceTypesHeaders headers) returns SourceType|error

Update SourceType

Parameters

dataAreaId string - The company data area identifier

sourceTypeId string - The source type id key field

payload SourceType - The request body

headers UpdateSourceTypesHeaders (default {}) - Headers to be sent with the request

Return Type

SourceType|error - SourceType updated

listSysAADClients

Isolated FunctionRemote Function

function listSysAADClients(map<string|string[]> headers, *ListSysAADClientsQueries queries) returns SysAADClientsCollection|error

List SysAADClients

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListSysAADClientsQueries - Queries to be sent with the request

Return Type

SysAADClientsCollection|error - Collection of SysAADClient

createSysAADClients

Isolated FunctionRemote Function

function createSysAADClients(SysAADClient payload, map<string|string[]> headers) returns SysAADClient|error

Create SysAADClient

Parameters

payload SysAADClient - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SysAADClient|error - SysAADClient created

getSysAADClients

Isolated FunctionRemote Function

function getSysAADClients(string aADClientId, map<string|string[]> headers, *GetSysAADClientsQueries queries) returns SysAADClient|error

Get SysAADClient by key

Parameters

aADClientId string - The a ad client id key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetSysAADClientsQueries - Queries to be sent with the request

Return Type

SysAADClient|error - SysAADClient

deleteSysAADClients

Isolated FunctionRemote Function

function deleteSysAADClients(string aADClientId, DeleteSysAADClientsHeaders headers) returns error?

Delete SysAADClient

Parameters

aADClientId string - The a ad client id key field

headers DeleteSysAADClientsHeaders (default {}) - Headers to be sent with the request

Return Type

error? - SysAADClient deleted

updateSysAADClients

Isolated FunctionRemote Function

function updateSysAADClients(string aADClientId, SysAADClient payload, UpdateSysAADClientsHeaders headers) returns SysAADClient|error

Update SysAADClient

Parameters

aADClientId string - The a ad client id key field

payload SysAADClient - The request body

headers UpdateSysAADClientsHeaders (default {}) - Headers to be sent with the request

Return Type

SysAADClient|error - SysAADClient updated

listSysMonDatas

Isolated FunctionRemote Function

function listSysMonDatas(map<string|string[]> headers, *ListSysMonDatasQueries queries) returns SysMonDatasCollection|error

List SysMonDatas

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListSysMonDatasQueries - Queries to be sent with the request

Return Type

SysMonDatasCollection|error - Collection of SysMonData

createSysMonDatas

Isolated FunctionRemote Function

function createSysMonDatas(SysMonData payload, map<string|string[]> headers) returns SysMonData|error

Create SysMonData

Parameters

payload SysMonData - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SysMonData|error - SysMonData created

getSysMonDatas

Isolated FunctionRemote Function

function getSysMonDatas(string description, map<string|string[]> headers, *GetSysMonDatasQueries queries) returns SysMonData|error

Get SysMonData by key

Parameters

description string - The description key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetSysMonDatasQueries - Queries to be sent with the request

Return Type

SysMonData|error - SysMonData

deleteSysMonDatas

Isolated FunctionRemote Function

function deleteSysMonDatas(string description, DeleteSysMonDatasHeaders headers) returns error?

Delete SysMonData

Parameters

description string - The description key field

headers DeleteSysMonDatasHeaders (default {}) - Headers to be sent with the request

Return Type

error? - SysMonData deleted

updateSysMonDatas

Isolated FunctionRemote Function

function updateSysMonDatas(string description, SysMonData payload, UpdateSysMonDatasHeaders headers) returns SysMonData|error

Update SysMonData

Parameters

description string - The description key field

payload SysMonData - The request body

headers UpdateSysMonDatasHeaders (default {}) - Headers to be sent with the request

Return Type

SysMonData|error - SysMonData updated

listSystemUsers

Isolated FunctionRemote Function

function listSystemUsers(map<string|string[]> headers, *ListSystemUsersQueries queries) returns SystemUsersCollection|error

List SystemUsers

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListSystemUsersQueries - Queries to be sent with the request

Return Type

SystemUsersCollection|error - Collection of SystemUser

createSystemUsers

Isolated FunctionRemote Function

function createSystemUsers(SystemUser payload, map<string|string[]> headers) returns SystemUser|error

Create SystemUser

Parameters

payload SystemUser - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SystemUser|error - SystemUser created

getSystemUsers

Isolated FunctionRemote Function

function getSystemUsers(string userID, map<string|string[]> headers, *GetSystemUsersQueries queries) returns SystemUser|error

Get SystemUser by key

Parameters

userID string - The user id key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetSystemUsersQueries - Queries to be sent with the request

Return Type

SystemUser|error - SystemUser

deleteSystemUsers

Isolated FunctionRemote Function

function deleteSystemUsers(string userID, DeleteSystemUsersHeaders headers) returns error?

Delete SystemUser

Parameters

userID string - The user id key field

headers DeleteSystemUsersHeaders (default {}) - Headers to be sent with the request

Return Type

error? - SystemUser deleted

updateSystemUsers

Isolated FunctionRemote Function

function updateSystemUsers(string userID, SystemUser payload, UpdateSystemUsersHeaders headers) returns SystemUser|error

Update SystemUser

Parameters

userID string - The user id key field

payload SystemUser - The request body

headers UpdateSystemUsersHeaders (default {}) - Headers to be sent with the request

Return Type

SystemUser|error - SystemUser updated

listUserGroups

Isolated FunctionRemote Function

function listUserGroups(map<string|string[]> headers, *ListUserGroupsQueries queries) returns UserGroupsCollection|error

List UserGroups

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListUserGroupsQueries - Queries to be sent with the request

Return Type

UserGroupsCollection|error - Collection of UserGroup

createUserGroups

Isolated FunctionRemote Function

function createUserGroups(UserGroup payload, map<string|string[]> headers) returns UserGroup|error

Create UserGroup

Parameters

payload UserGroup - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UserGroup|error - UserGroup created

getUserGroups

Isolated FunctionRemote Function

function getUserGroups(string groupId, map<string|string[]> headers, *GetUserGroupsQueries queries) returns UserGroup|error

Get UserGroup by key

Parameters

groupId string - The group id key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetUserGroupsQueries - Queries to be sent with the request

Return Type

UserGroup|error - UserGroup

deleteUserGroups

Isolated FunctionRemote Function

function deleteUserGroups(string groupId, DeleteUserGroupsHeaders headers) returns error?

Delete UserGroup

Parameters

groupId string - The group id key field

headers DeleteUserGroupsHeaders (default {}) - Headers to be sent with the request

Return Type

error? - UserGroup deleted

updateUserGroups

Isolated FunctionRemote Function

function updateUserGroups(string groupId, UserGroup payload, UpdateUserGroupsHeaders headers) returns UserGroup|error

Update UserGroup

Parameters

groupId string - The group id key field

payload UserGroup - The request body

headers UpdateUserGroupsHeaders (default {}) - Headers to be sent with the request

Return Type

UserGroup|error - UserGroup updated

Records

microsoft.dynamics365.finance.users: ChannelUser

Fields

dataAreaId? string -

user? string -

operatingUnitNumber? string -

microsoft.dynamics365.finance.users: ChannelUsersCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *ChannelUsersCollectionAllOf2

value ChannelUser[]
anydata...

microsoft.dynamics365.finance.users: ChannelUsersCollectionAllOf2

Fields

value? ChannelUser[] -

microsoft.dynamics365.finance.users: ConnectionConfig

Closed record

Fields

auth? OAuth2ClientCredentialsGrantConfig - Configurations related to client authentication

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol

timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

followRedirects? FollowRedirects - Configurations associated with Redirection

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache CacheConfig(default {}) - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

cookieConfig? CookieConfig - Configurations associated with cookies

responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default.

microsoft.dynamics365.finance.users: DeleteChannelUsersHeaders

Represents the Headers record for the operation: deleteChannelUsers

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: DeleteExternalRolesHeaders

Represents the Headers record for the operation: deleteExternalRoles

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: DeleteGroupsHeaders

Represents the Headers record for the operation: deleteGroups

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: DeleteSecurityRolesHeaders

Represents the Headers record for the operation: deleteSecurityRoles

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: DeleteSourceSystemsHeaders

Represents the Headers record for the operation: deleteSourceSystems

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: DeleteSourceTypesHeaders

Represents the Headers record for the operation: deleteSourceTypes

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: DeleteSysAADClientsHeaders

Represents the Headers record for the operation: deleteSysAADClients

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: DeleteSysMonDatasHeaders

Represents the Headers record for the operation: deleteSysMonDatas

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: DeleteSystemUsersHeaders

Represents the Headers record for the operation: deleteSystemUsers

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: DeleteUserGroupsHeaders

Represents the Headers record for the operation: deleteUserGroups

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: ExternalRole

Fields

role? string -

'type? UserExternalPartyEntityType -

microsoft.dynamics365.finance.users: ExternalRolesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *ExternalRolesCollectionAllOf2

value ExternalRole[]
anydata...

microsoft.dynamics365.finance.users: ExternalRolesCollectionAllOf2

Fields

value? ExternalRole[] -

microsoft.dynamics365.finance.users: GetChannelUsersQueries

Represents the Queries record for the operation: getChannelUsers

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: GetExternalRolesQueries

Represents the Queries record for the operation: getExternalRoles

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: GetGroupsQueries

Represents the Queries record for the operation: getGroups

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: GetSecurityRolesQueries

Represents the Queries record for the operation: getSecurityRoles

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: GetSourceSystemsQueries

Represents the Queries record for the operation: getSourceSystems

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: GetSourceTypesQueries

Represents the Queries record for the operation: getSourceTypes

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: GetSysAADClientsQueries

Represents the Queries record for the operation: getSysAADClients

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: GetSysMonDatasQueries

Represents the Queries record for the operation: getSysMonDatas

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: GetSystemUsersQueries

Represents the Queries record for the operation: getSystemUsers

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: GetUserGroupsQueries

Represents the Queries record for the operation: getUserGroups

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: Group

Fields

modelNumber? string -

dataAreaId? string -

vATOffsetMethodForDeferrals? RDeferralsVATRefundingMethod -

postingProfile? string -

dimensionDisplayValue? string -

writingOffTime? Signed32 -

writingOffMethod? string -

beginningDateOfWritingOff? RDeferralsInitWriteStartDate -

disposalDate? RDeferralsInitRetirementDate -

deferralsGroup? string -

name? string -

microsoft.dynamics365.finance.users: GroupsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *GroupsCollectionAllOf2

value Group[]
anydata...

microsoft.dynamics365.finance.users: GroupsCollectionAllOf2

Fields

value? Group[] -

microsoft.dynamics365.finance.users: ListChannelUsersQueries

Represents the Queries record for the operation: listChannelUsers

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: ListExternalRolesQueries

Represents the Queries record for the operation: listExternalRoles

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: ListGroupsQueries

Represents the Queries record for the operation: listGroups

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: ListSecurityRolesQueries

Represents the Queries record for the operation: listSecurityRoles

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: ListSourceSystemsQueries

Represents the Queries record for the operation: listSourceSystems

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: ListSourceTypesQueries

Represents the Queries record for the operation: listSourceTypes

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: ListSysAADClientsQueries

Represents the Queries record for the operation: listSysAADClients

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: ListSysMonDatasQueries

Represents the Queries record for the operation: listSysMonDatas

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: ListSystemUsersQueries

Represents the Queries record for the operation: listSystemUsers

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: ListUserGroupsQueries

Represents the Queries record for the operation: listUserGroups

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.users: OAuth2ClientCredentialsGrantConfig

Closed record

OAuth2 Client Credentials Grant Configs

Fields

Fields Included from *OAuth2ClientCredentialsGrantConfig

tokenUrl string
clientId string
clientSecret string
scopes string|string[]
defaultTokenExpTime decimal
clockSkew decimal
optionalParams map<string>
credentialBearer CredentialBearer
clientConfig ClientConfiguration

tokenUrl string(default "https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token") - Token URL

microsoft.dynamics365.finance.users: ODataCollection

Fields

odataNextLink? string -

odataCount? int -

odataContext? string -

microsoft.dynamics365.finance.users: SecurityRole

Fields

description? string -

securityRoleIdentifier? string -

accessToSensitiveData? boolean -

contextString? string -

userLicenseType? UserLicenseType -

securityRoleName? string -

microsoft.dynamics365.finance.users: SecurityRolesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *SecurityRolesCollectionAllOf2

value SecurityRole[]
anydata...

microsoft.dynamics365.finance.users: SecurityRolesCollectionAllOf2

Fields

value? SecurityRole[] -

microsoft.dynamics365.finance.users: SourceSystem

Fields

description? string -

name? string -

microsoft.dynamics365.finance.users: SourceSystemsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *SourceSystemsCollectionAllOf2

value SourceSystem[]
anydata...

microsoft.dynamics365.finance.users: SourceSystemsCollectionAllOf2

Fields

value? SourceSystem[] -

microsoft.dynamics365.finance.users: SourceType

Fields

dataAreaId? string -

description? string -

sourceTypeId? string -

direction? AssetSourceDirectionCN -

microsoft.dynamics365.finance.users: SourceTypesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *SourceTypesCollectionAllOf2

value SourceType[]
anydata...

microsoft.dynamics365.finance.users: SourceTypesCollectionAllOf2

Fields

value? SourceType[] -

microsoft.dynamics365.finance.users: SysAADClient

Fields

userId? string -

aADClientId? string -

name? string -

microsoft.dynamics365.finance.users: SysAADClientsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *SysAADClientsCollectionAllOf2

value SysAADClient[]
anydata...

microsoft.dynamics365.finance.users: SysAADClientsCollectionAllOf2

Fields

value? SysAADClient[] -

microsoft.dynamics365.finance.users: SysMonData

Fields

description? string -

microsoft.dynamics365.finance.users: SysMonDatasCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *SysMonDatasCollectionAllOf2

value SysMonData[]
anydata...

microsoft.dynamics365.finance.users: SysMonDatasCollectionAllOf2

Fields

value? SysMonData[] -

microsoft.dynamics365.finance.users: SystemUser

Fields

company? string -

email? string -

preferredTimeZone? Timezone -

eventWorkflowTasksInActionCenter? NoYes -

eventPopUpLinkDestination? EventPopUpLinkDestination -

density? SysUserInfoDensity -

globalExcelExportFilePath? string -

eventPopUpDisplayWhen? EventPopupShowDefineMode -

homePageRefreshDuration? Signed32 -

defaultCountryRegion? string -

language? string -

markEmptyLinks? NoYes -

userID? string -

helplanguage? string -

documentHandlingActive? NoYes -

showAttachmentStatus? NoYes -

eventWorkflowShowPopup? NoYes -

sqmGUID? string -

personName? string -

sendNotificationsInEmail? NoYes -

sendAlertAsEmailMessage? EventEmailSendDefineMode -

userName? string -

eventPollFrequency? Signed32 -

workflowLineItemNotificationFormat? WorkflowLineItemNotificationFormat -

externalUser? boolean -

eventPopUps? NoYes -

enabled? boolean -

preferredLocale? string -

accountType? UserAccountType -

globalListPageLinkMode? Signed32 -

userInfoDefaultPartition? boolean -

preferredCalendar? PreferredCalendar -

emailProviderID? string -

startPage? string -

showNotificationsInTheMicrosoftDynamicsAX7Client? NoYes -

alias? string -

theme? SysUserInfoTheme -

automaticUrlUpdate? NoYes -

globalExcelExportMode? Signed32 -

userInfoLanguage? string -

networkDomain? string -

sqmEnabled? SysSqmEnabledClient -

autoLogOff? Signed32 -

microsoft.dynamics365.finance.users: SystemUsersCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *SystemUsersCollectionAllOf2

value SystemUser[]
anydata...

microsoft.dynamics365.finance.users: SystemUsersCollectionAllOf2

Fields

value? SystemUser[] -

microsoft.dynamics365.finance.users: Type

Fields

dataAreaId? string -

shortName? string -

flTypeId? string -

name? string -

microsoft.dynamics365.finance.users: UpdateChannelUsersHeaders

Represents the Headers record for the operation: updateChannelUsers

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: UpdateExternalRolesHeaders

Represents the Headers record for the operation: updateExternalRoles

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: UpdateGroupsHeaders

Represents the Headers record for the operation: updateGroups

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: UpdateSecurityRolesHeaders

Represents the Headers record for the operation: updateSecurityRoles

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: UpdateSourceSystemsHeaders

Represents the Headers record for the operation: updateSourceSystems

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: UpdateSourceTypesHeaders

Represents the Headers record for the operation: updateSourceTypes

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: UpdateSysAADClientsHeaders

Represents the Headers record for the operation: updateSysAADClients

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: UpdateSysMonDatasHeaders

Represents the Headers record for the operation: updateSysMonDatas

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: UpdateSystemUsersHeaders

Represents the Headers record for the operation: updateSystemUsers

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: UpdateUserGroupsHeaders

Represents the Headers record for the operation: updateUserGroups

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.users: UserGroup

Fields

name? string -

groupId? string -

microsoft.dynamics365.finance.users: UserGroupsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *UserGroupsCollectionAllOf2

value UserGroup[]
anydata...

microsoft.dynamics365.finance.users: UserGroupsCollectionAllOf2

Fields

value? UserGroup[] -

Union types

microsoft.dynamics365.finance.users: SysUserInfoTheme

SysUserInfoTheme

microsoft.dynamics365.finance.users: SysUserInfoDensity

"Density30"|"Density21"

SysUserInfoDensity

microsoft.dynamics365.finance.users: UserExternalPartyEntityType

"Customer"|"Vendor"|"BusinessRelation"|"ProspectiveVendor"|"Worker"

UserExternalPartyEntityType

microsoft.dynamics365.finance.users: RDeferralsInitWriteStartDate

"NextMonth"|"NextQuarter"|"NextHalfYear"|"NextYear"|"CreatedDate"

RDeferralsInitWriteStartDate

microsoft.dynamics365.finance.users: PreferredCalendar

"Gregorian"|"Hijri"|"UmAlQura"

PreferredCalendar

microsoft.dynamics365.finance.users: UserAccountType

"ADUser"|"ADGroup"|"ClaimsUser"|"ClaimsGroup"

UserAccountType

microsoft.dynamics365.finance.users: SysSqmEnabledClient

"Yes"|"No"|"PromptMe"

SysSqmEnabledClient

microsoft.dynamics365.finance.users: UserLicenseType

UserLicenseType

microsoft.dynamics365.finance.users: Timezone

Timezone

microsoft.dynamics365.finance.users: EventPopUpLinkDestination

"ToAlert"|"ToAlertOrigin"

EventPopUpLinkDestination

microsoft.dynamics365.finance.users: EventEmailSendDefineMode

"DefinedOnRule"|"AllRules"|"NoRules"

EventEmailSendDefineMode

microsoft.dynamics365.finance.users: WorkflowLineItemNotificationFormat

"Grouped"|"Individual"

WorkflowLineItemNotificationFormat

microsoft.dynamics365.finance.users: AssetSourceDirectionCN

"In"|"Out"

AssetSourceDirectionCN

microsoft.dynamics365.finance.users: RDeferralsVATRefundingMethod

"Standard"|"Proportional"

RDeferralsVATRefundingMethod

microsoft.dynamics365.finance.users: RDeferralsInitRetirementDate

"None"|"EndOfYear"

RDeferralsInitRetirementDate

microsoft.dynamics365.finance.users: NoYes

"No"|"Yes"

NoYes

microsoft.dynamics365.finance.users: EventPopupShowDefineMode

"DefinedOnRule"|"AllRules"|"NoRules"

EventPopupShowDefineMode

Import

import ballerinax/microsoft.dynamics365.finance.users;

Other versions

0.8.0

Metadata

Released date: 1 day ago

Version: 0.8.0

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.13.0

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Source repository

Keywords

Name/Microsoft Dynamics 365 Finance Users

Area/System

Vendor/Microsoft

Dynamics365

Finance

ERP

Type/Connector

User

Security

Role

Identity

Contributors

Dependencies

ballerina/data.jsondata/1.1.3 ballerina/url/2.6.1 ballerina/http/2.16.3

Cookie policy

Delete policy

clients

records

unionTypes

ballerinax/microsoft.dynamics365.finance.users Ballerina library

Overview

Key Features

Setup guide

Prerequisites

Step 1: Register an application in Azure AD

Step 2: Grant Dynamics 365 API permissions

Step 3: Add the app as a D365 user

Quickstart

Step 1: Import the module

Step 2: Instantiate a new connector

Step 3: Invoke the connector operation

Step 4: Run the Ballerina application

Examples

Clients

microsoft.dynamics365.finance.users: Client

Constructor

listChannelUsers

Parameters

Return Type

createChannelUsers

Parameters

Return Type

getChannelUsers

Parameters

Return Type

deleteChannelUsers

Parameters

Return Type

updateChannelUsers

Parameters

Return Type

listExternalRoles

Parameters

Return Type

createExternalRoles

Parameters

Return Type

getExternalRoles

Parameters

Return Type

deleteExternalRoles

Parameters

Return Type

updateExternalRoles

Parameters

Return Type

listGroups

Parameters

Return Type

createGroups

Parameters

Return Type

getGroups

Parameters

Return Type

deleteGroups

Parameters

Return Type

updateGroups

Parameters

Return Type

listSecurityRoles

Parameters

Return Type

createSecurityRoles

Parameters

Return Type

getSecurityRoles

Parameters

Return Type

deleteSecurityRoles

Parameters

Return Type

updateSecurityRoles

Parameters

Return Type