mySparkrock user properties and user permission set APIs

To set up mySparkrock user properties and user permission sets in Sparkrock Impact, use the following APIs.

List of users

To get a list of all users, use:

GET https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/microsoft/automation/v2.0/companies({companyid})/users
Authorization: Bearer {token}

Copy

Properties of all users

To get the properties of all users, use:

GET https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/microsoft/automation/v2.0/companies({companyid})/users({userSecurityId})
Authorization: Bearer {token}

Copy

Properties of a specific user

To get the properties of a specific user, use:

GET https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/microsoft/automation/v2.0/companies({companyid})/users?$filter=userName eq 'sparkrockapi'
Authorization: Bearer {token}

Copy

Modify user properties

To get the current user properties, use:

GET https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/microsoft/automation/v2.0/companies({companyid})/users?$filter=userName eq 'sparkrockapi'
Authorization: Bearer {token}

Copy

This request gets the UserSecurityId that is required for subsequent requests.

To modify the user, use:

PATCH https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/microsoft/automation/v2.0/companies({companyid})/users({userSecurityId})
Authorization: Bearer {token}
Content-type: application/json
If-Match: *
{
    "state": "Enabled",
    "expiryDate": "2035-01-01T21:03:53.444Z"
}

Copy

List of permission sets

To retrieve a list of permission sets, use:

GET https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/microsoft/automation/v2.0/companies({companyId})/permissionSets
Authorization: Bearer {token}

Copy

This request returns information about the available permission sets.

List of user permissions

To get the list of all user permission for a specific user, use:

GET https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/microsoft/automation/v2.0/companies({companyid})/users({userSecurityId})/userPermissions
Authorization: Bearer {token}

Copy

This request gets the userPermissionId that is required for subsequent requests.

Assign user permissions

To assign permission sets to a user, use:

POST https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/microsoft/automation/v2.0/companies({companyId})/users({userSecurityId})/userPermissions
Authorization: Bearer {token}
Content-type: application/json
{ 
    "roleId": "SECURITY",
    "company" : "Sparkrock"
}

Copy

Delete user permission

To get the current user permissions, use:

GET https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/microsoft/automation/v2.0/companies({companyid})/users({userSecurityId})/userPermissions
Authorization: Bearer {token}

Copy

This request gets the UserSecurityId that is required for subsequent requests.

To remove the user permission from the user, use:

DELETE https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/microsoft/automation/v2.0/companies({companyId})/users({userSecurityId})/userPermissions({userPermissionId})
Authorization: Bearer {token}
If-Match: *

Copy

Related information

mySparkrock user provisioning APIs

Feedback

To send feedback about this page, select the following link:

feedback-product-docs@sparkrock.com