Admin Management Service (v1)

Download OpenAPI specification:Download

AuditContext

Generate audit context

Generates a new audit context identifier which trackes the changes from database for a specific tenant. It serves as key when editing or adding records in tenant database.

header Parameters

Authorization

string

The BasicAuth token

Request Body schema:
application/json

The audit context request containing the list of the persons involved in changes under audit, the app name creating the audit context (e.g. backoffice, services, migrating) and the authorized appId. The list of persons can be null if no person is involved in changes, e.g. registering contact.

PersonIds	Array of integers <int32>
Createdby	string
AuthorizedAppId	string

Responses

200

Successfully generated audit context identifier

post /v1.0/auditcontext/generate

https://example-host/v1.0/auditcontext/generate

Request samples

Payload

Content type

Copy

Expand all Collapse all

{

"PersonIds":
[
- 1,
- 2,
- 4
],
"Createdby": "backoffice",
"AuthorizedAppId": "jGER285mdgZuDq50PadB1ITWv3tM9Y"

}

IdentityRoleHierarchy

Get all roles

Get all the roles with hierarchy level (rank) information

header Parameters

Authorization

string

The BasicAuth token

Responses

200

Successfully found the list of roles

404

Couldn't find the list of roles

get /v2.0/roles

https://example-host/v2.0/roles

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "Id": 1,
- "Name": "System-Administrator",
- "HierarchyLevel": 1
},
{
- "Id": 44,
- "Name": "Area Manager",
- "HierarchyLevel": 2
},
{
- "Id": 41,
- "Name": "Assistant RM",
- "HierarchyLevel": 2
},
{
- "Id": 45,
- "Name": "Business Development",
- "HierarchyLevel": 2
},
{
- "Id": 43,
- "Name": "Team Leader",
- "HierarchyLevel": 3
},
{
- "Id": 35,
- "Name": "Relationship Manager",
- "HierarchyLevel": 4
},
{
- "Id": 46,
- "Name": "Business Analyst",
- "HierarchyLevel": 5
},
{
- "Id": 42,
- "Name": "Secretary",
- "HierarchyLevel": 6
}

]

Get all the tenant policy members

header Parameters

Authorization

string

The BasicAuth token

Responses

200

Successfully found the list of tenant member policy items

404

Couldn't find the list of tenant member policy items

get /v2.0/members

https://example-host/v2.0/members

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "Member":
  {
  - "Id": 1,
  - "FirstName": "Michael",
  - "LastName": "Grabchak"
  },
- "Role":
  {
  - "Id": 1,
  - "Name": "System-Administrator",
  - "HierarchyLevel": 1
  }
},
{
- "Member":
  {
  - "Id": 2,
  - "FirstName": "Xabier",
  - "LastName": "Gonzalez"
  },
- "Role":
  {
  - "Id": 35,
  - "Name": "Relationship Manager",
  - "HierarchyLevel": 4
  }
}

]

Get role hierarchy by Role ID

path Parameters

roleId

required

integer <int32>

The role ID of Base element of the Role Hierarchy

header Parameters

Authorization

string

The BasicAuth token

Responses

200

Successfully found the role hierarchy

404

Couldn't find the role hierarchy by specified role

422

Couldn't process the request. The Role ID is invalid

get /v2.0/roles/{roleId}/hierarchy

https://example-host/v2.0/roles/{roleId}/hierarchy

Response samples

Content type

Copy

Expand all Collapse all

{

"Base":
{
- "Id": 1,
- "Name": "System-Administrator",
- "HierarchyLevel": 1
},
"HierarchyItems":
[
- {
  - "Id": 2,
  - "Name": "Support Lead",
  - "HierarchyLevel": 2
  },
- {
  - "Id": 3,
  - "Name": "Sale Team Lead",
  - "HierarchyLevel": 2
  },
- {
  - "Id": 4,
  - "Name": "Support Manager",
  - "HierarchyLevel": 3
  },
- {
  - "Id": 5,
  - "Name": "Sales Manager",
  - "HierarchyLevel": 3
  },
- {
  - "Id": 6,
  - "Name": "Support Rep",
  - "HierarchyLevel": 4
  },
- {
  - "Id": 7,
  - "Name": "Sales Rep",
  - "HierarchyLevel": 4
  }
]

}

Get member-role hierarchy by Member ID

path Parameters

internalId

required

string <uuid>

The Internal ID of the Base element of the Member Role Hierarchy

header Parameters

Authorization

string

The BasicAuth token

Responses

200

Successfully found the member role hierarchy

404

Couldn't find the member role hierarchy by specified member

422

Couldn't process the request. The Member ID is invalid

get /v2.0/members/{internalId}/hierarchy

https://example-host/v2.0/members/{internalId}/hierarchy

Response samples

Content type

Copy

Expand all Collapse all

{

"Superiors":
[
- {
  - "Member":
    {
    "Id": 1,
    "FirstName": "John",
    "LastName": "Smith"
    },
  - "Role":
    {
    "Id": 1,
    "Name": "Big-Boss",
    "HierarchyLevel": 1
    }
  }
],
"Base":
{
- "Member":
  {
  - "Id": 2,
  - "FirstName": "Fabio Ochoa",
  - "LastName": "Navaro"
  },
- "Role":
  {
  - "Id": 2,
  - "Name": "Relationship Manager",
  - "HierarchyLevel": 2
  }
},
"HierarchyItems":
[
- {
  - "Member":
    {
    "Id": 3,
    "FirstName": "Xabier",
    "LastName": "Gonzalez"
    },
  - "Role":
    {
    "Id": 3,
    "Name": "Associate Relationship Manager",
    "HierarchyLevel": 3
    }
  }
]

}

Change the hierarchy rank of specified role

path Parameters

roleId required	integer <int32> The role ID
operation required	string Enum: "Unknown" "Up" "Down" The role hierarchy rank change operation (up or down)

header Parameters

Authorization

string

The BasicAuth token

Responses

200

Successfully changed the rank of role

404

Couldn't find the role

422

Couldn't process the request. The Role ID is invalid or operation is Unknown

put /v2.0/roles/{roleId}/hierarchy/rank/{operation}

https://example-host/v2.0/roles/{roleId}/hierarchy/rank/{operation}

Set the role hierarchy restrictions

Set the role hierarchy restrictions (forbidden sub-role(s) access) for specified Role ID

path Parameters

roleId

required

integer <int32>

The Role ID

header Parameters

Authorization

string

The BasicAuth token

Request Body schema:
application/json

The list of restricted sub-roles

Array

integer <int32>

Responses

200

Successfully set the role hierarchy restrictions

422

Couldn't process the request. The Role ID is invalid or restricted roles collection is not specified

post /v2.0/roles/{roleId}/hierarchy/restrictions

https://example-host/v2.0/roles/{roleId}/hierarchy/restrictions

Request samples

Payload

Content type

Copy

Expand all Collapse all

[

]

Set the member-role hierarchy restrictions

Set the member-role hierarchy restrictions (forbidden sub-member(s) access) for specified Member ID

path Parameters

internalId

required

string <uuid>

The Internal ID of the IdentityUser

header Parameters

Authorization

string

The BasicAuth token

Request Body schema:
application/json

The list of restricted sub-users

Array

string <uuid>

Responses

200

Successfully set the member role hierarchy restrictions

422

Couldn't process the request. The Member ID is invalid or restricted members collection is not specified

post /v2.0/members/{internalId}/hierarchy/restrictions

https://example-host/v2.0/members/{internalId}/hierarchy/restrictions

Request samples

Payload

Content type

Copy

Expand all Collapse all

[

"00000000-0000-0000-0000-000000000000"

]

Member has hierarchy access

Check whether a person (contact or member) is in the hierarchy of a member.

path Parameters

internalId

required

string <uuid>

The Internal ID of the Base element of the Member Role Hierarchy

header Parameters

Authorization

string

The BasicAuth token

Request Body schema:
application/json

The request which contains the checked person ID from the hierarchy of the member.

PersonId

integer <int32>

Responses

200

The member has access to person.

404

Couldn't find the member role hierarchy by specified member

422

Couldn't process the request. The Member ID is invalid

post /v2.0/members/{internalId}/hierarchy/access

https://example-host/v2.0/members/{internalId}/hierarchy/access

Request samples

Payload

Content type

Copy

Expand all Collapse all

{

"PersonId": 2

}

Response samples

Content type

Copy

Expand all Collapse all

true

Member

Get all active members

header Parameters

Authorization

string

The BasicAuth token

Request Body schema:
application/json

The filter

SortColumn	string
SortOrder	string
Offset	integer <int32>
Limit	integer <int32>
Search	string
FirstName	string
LastName	string
BranchId	integer <int32>
CountryId	integer <int32>
RoleId	integer <int32>

Responses

200

Successfully found the list of active members

404

Couldn't find the list of active members

post /v1.0/members/active

https://example-host/v1.0/members/active

Request samples

Payload

Content type

Copy

Expand all Collapse all

{

"SortColumn": "string",
"SortOrder": "string",
"Offset": 0,
"Limit": 0,
"Search": "string",
"FirstName": "string",
"LastName": "string",
"BranchId": 0,
"CountryId": 0,
"RoleId": 0

}

Response samples

Content type

Copy

Expand all Collapse all

{

"Filtered":
[
- {
  - "Id": 1,
  - "UserName": "user1",
  - "Role":
    {
    "Id": 1,
    "Name": "System-Administrator",
    "HierarchyLevel": 0
    },
  - "FirstName": "User1",
  - "LastName": "Ferdinand",
  - "Email": "user1@email.com"
  },
- {
  - "Id": 2,
  - "UserName": "user2",
  - "Role":
    {
    "Id": 1,
    "Name": "System-Administrator",
    "HierarchyLevel": 0
    },
  - "FirstName": "User2",
  - "LastName": "Ferdinand",
  - "Email": "user2@email.com"
  }
],
"TotalCount": 2

}

MemberPolicyTenant

Creates a Member Policy Tenant entity

header Parameters

Authorization

string

The BasicAuth token

Request Body schema:
application/json

The Member Policy Tenant payload

MemberRoleId	integer <int32>
MemberId	integer <int32>
UserName	string
PasswordHashed	string
PasswordCreateDate	string <date-time>
IsLoggedIn	boolean
LastModifiedById	integer <int32>

Responses

200

Successfully created the Member Policy Tenant

post /v1.0/memberPolicy

https://example-host/v1.0/memberPolicy

Request samples

Payload

Content type

Copy

Expand all Collapse all

{

"MemberRoleId": 0,
"MemberId": 0,
"UserName": "string",
"PasswordHashed": "string",
"PasswordCreateDate": "2019-11-14T03:21:28Z",
"IsLoggedIn": true,
"LastModifiedById": 0

}

MemberRoleHierarchy

Get all roles

Get all the roles with hierarchy level (rank) information

header Parameters

Authorization

string

The BasicAuth token

Responses

200

Successfully found the list of roles

404

Couldn't find the list of roles

get /v1.0/roles

https://example-host/v1.0/roles

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "Id": 1,
- "Name": "System-Administrator",
- "HierarchyLevel": 1
},
{
- "Id": 44,
- "Name": "Area Manager",
- "HierarchyLevel": 2
},
{
- "Id": 41,
- "Name": "Assistant RM",
- "HierarchyLevel": 2
},
{
- "Id": 45,
- "Name": "Business Development",
- "HierarchyLevel": 2
},
{
- "Id": 43,
- "Name": "Team Leader",
- "HierarchyLevel": 3
},
{
- "Id": 35,
- "Name": "Relationship Manager",
- "HierarchyLevel": 4
},
{
- "Id": 46,
- "Name": "Business Analyst",
- "HierarchyLevel": 5
},
{
- "Id": 42,
- "Name": "Secretary",
- "HierarchyLevel": 6
}

]

Get all the tenant policy members

header Parameters

Authorization

string

The BasicAuth token

Responses

200

Successfully found the list of tenant member policy items

404

Couldn't find the list of tenant member policy items

get /v1.0/members

https://example-host/v1.0/members

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "Member":
  {
  - "Id": 1,
  - "FirstName": "Michael",
  - "LastName": "Grabchak"
  },
- "Role":
  {
  - "Id": 1,
  - "Name": "System-Administrator",
  - "HierarchyLevel": 1
  }
},
{
- "Member":
  {
  - "Id": 2,
  - "FirstName": "Xabier",
  - "LastName": "Gonzalez"
  },
- "Role":
  {
  - "Id": 35,
  - "Name": "Relationship Manager",
  - "HierarchyLevel": 4
  }
}

]

Get all contacts by Member ID Deprecated

The API is DEPRECATED. Please use Service Layer API endpoint /v1.0/members/{memberId}/hierarchy/contacts instead

Get all the contacts based on member role hierarchy

path Parameters

memberId

required

integer <int32>

header Parameters

Authorization

string

The BasicAuth token

Responses

200

Successfully found the list of contacts by member role hierarchy

404

Couldn't find the list of contacts by specified member (member role hierarchy)

422

Couldn't process the request. The Member ID is invalid

get /v1.0/members/{memberId}/hierarchy/contacts

https://example-host/v1.0/members/{memberId}/hierarchy/contacts

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "MemberId": 1,
- "ContactId": 40,
- "ContactName": "John Doe"
},
{
- "MemberId": 1,
- "ContactId": 42,
- "ContactName": "Jon Snow"
},
{
- "MemberId": 2,
- "ContactId": 60,
- "ContactName": "John Smith"
},
{
- "MemberId": 2,
- "ContactId": 523,
- "ContactName": "Emma Stone"
},
{
- "MemberId": 7,
- "ContactId": 34,
- "ContactName": "Tony Stark"
}

]

Get role hierarchy by Role ID

path Parameters

roleId

required

integer <int32>

The role ID of Base element of the Role Hierarchy

header Parameters

Authorization

string

The BasicAuth token

Responses

200

Successfully found the role hierarchy

404

Couldn't find the role hierarchy by specified role

422

Couldn't process the request. The Role ID is invalid

get /v1.0/roles/{roleId}/hierarchy

https://example-host/v1.0/roles/{roleId}/hierarchy

Response samples

Content type

Copy

Expand all Collapse all

{

"Base":
{
- "Id": 1,
- "Name": "System-Administrator",
- "HierarchyLevel": 1
},
"HierarchyItems":
[
- {
  - "Id": 2,
  - "Name": "Support Lead",
  - "HierarchyLevel": 2
  },
- {
  - "Id": 3,
  - "Name": "Sale Team Lead",
  - "HierarchyLevel": 2
  },
- {
  - "Id": 4,
  - "Name": "Support Manager",
  - "HierarchyLevel": 3
  },
- {
  - "Id": 5,
  - "Name": "Sales Manager",
  - "HierarchyLevel": 3
  },
- {
  - "Id": 6,
  - "Name": "Support Rep",
  - "HierarchyLevel": 4
  },
- {
  - "Id": 7,
  - "Name": "Sales Rep",
  - "HierarchyLevel": 4
  }
]

}

Get member-role hierarchy by Member ID

path Parameters

memberId

required

integer <int32>

The member ID of the Base element of the Member Role Hierarchy

header Parameters

Authorization

string

The BasicAuth token

Responses

200

Successfully found the member role hierarchy

404

Couldn't find the member role hierarchy by specified member

422

Couldn't process the request. The Member ID is invalid

get /v1.0/members/{memberId}/hierarchy

https://example-host/v1.0/members/{memberId}/hierarchy

Response samples

Content type

Copy

Expand all Collapse all

{

"Superiors":
[
- {
  - "Member":
    {
    "Id": 1,
    "FirstName": "John",
    "LastName": "Smith"
    },
  - "Role":
    {
    "Id": 1,
    "Name": "Big-Boss",
    "HierarchyLevel": 1
    }
  }
],
"Base":
{
- "Member":
  {
  - "Id": 2,
  - "FirstName": "Fabio Ochoa",
  - "LastName": "Navaro"
  },
- "Role":
  {
  - "Id": 2,
  - "Name": "Relationship Manager",
  - "HierarchyLevel": 2
  }
},
"HierarchyItems":
[
- {
  - "Member":
    {
    "Id": 3,
    "FirstName": "Xabier",
    "LastName": "Gonzalez"
    },
  - "Role":
    {
    "Id": 3,
    "Name": "Associate Relationship Manager",
    "HierarchyLevel": 3
    }
  }
]

}

Change the hierarchy rank of specified role

path Parameters

roleId required	integer <int32> The role ID
operation required	string Enum: "Unknown" "Up" "Down" The role hierarchy rank change operation (up or down)

header Parameters

Authorization

string

The BasicAuth token

Request Body schema:
application/json

The member ID of the person who triggered the operation

integer <int32>

Responses

200

Successfully changed the rank of role

404

Couldn't find the role

422

Couldn't process the request. The Role ID is invalid or operation is Unknown

post /v1.0/roles/{roleId}/hierarchy/rank/{operation}

https://example-host/v1.0/roles/{roleId}/hierarchy/rank/{operation}

Request samples

Payload

Content type

Copy

Expand all Collapse all

Set the role hierarchy restrictions

Set the role hierarchy restrictions (forbidden sub-role(s) access) for specified Role ID

path Parameters

roleId

required

integer <int32>

The Role ID

header Parameters

Authorization

string

The BasicAuth token

Request Body schema:
application/json

The list of restricted sub-roles

Array

integer <int32>

Responses

200

Successfully set the role hierarchy restrictions

422

Couldn't process the request. The Role ID is invalid or restricted roles collection is not specified

post /v1.0/roles/{roleId}/hierarchy/restrictions

https://example-host/v1.0/roles/{roleId}/hierarchy/restrictions

Request samples

Payload

Content type

Copy

Expand all Collapse all

[

]

Set the member-role hierarchy restrictions

Set the member-role hierarchy restrictions (forbidden sub-member(s) access) for specified Member ID

path Parameters

memberId

required

integer <int32>

The Member ID

header Parameters

Authorization

string

The BasicAuth token

Request Body schema:
application/json

The list of restricted sub-members

Array

integer <int32>

Responses

200

Successfully set the member role hierarchy restrictions

422

Couldn't process the request. The Member ID is invalid or restricted members collection is not specified

post /v1.0/members/{memberId}/hierarchy/restrictions

https://example-host/v1.0/members/{memberId}/hierarchy/restrictions

Request samples

Payload

Content type

Copy

Expand all Collapse all

[

]

Member has hierarchy access

Check whether a person (contact or member) is in the hierarchy of a member.

path Parameters

memberId

required

integer <int32>

The member ID of the Base element of the Member Role Hierarchy

header Parameters

Authorization

string

The BasicAuth token

Request Body schema:
application/json

The request which contains the checked person ID from the hierarchy of the member.

PersonId

integer <int32>

Responses

200

The member has access to person.

404

Couldn't find the member role hierarchy by specified member

422

Couldn't process the request. The Member ID is invalid

post /v1.0/members/{memberId}/hierarchy/access

https://example-host/v1.0/members/{memberId}/hierarchy/access

Request samples

Payload

Content type

Copy

Expand all Collapse all

{

"PersonId": 2

}

Response samples

Content type

Copy

Expand all Collapse all

true

Admin Management Service (v1)

AuditContext

Generate audit context

header Parameters

Request Body schema: application/json

Responses

Request samples

IdentityRoleHierarchy

Get all roles

header Parameters

Responses

Response samples

Get all the tenant policy members

header Parameters

Responses

Response samples

Get role hierarchy by Role ID

path Parameters

header Parameters

Responses

Response samples

Get member-role hierarchy by Member ID

path Parameters

header Parameters

Responses

Response samples

Change the hierarchy rank of specified role

path Parameters

header Parameters

Responses

Set the role hierarchy restrictions

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Set the member-role hierarchy restrictions

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Member has hierarchy access

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Member

Get all active members

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

MemberPolicyTenant

Creates a Member Policy Tenant entity

header Parameters

Request Body schema: application/json

Responses

Request samples

MemberRoleHierarchy

Get all roles

header Parameters

Responses

Response samples

Get all the tenant policy members

header Parameters

Responses

Response samples

Get all contacts by Member ID Deprecated

path Parameters

header Parameters

Responses

Response samples

Get role hierarchy by Role ID

path Parameters

header Parameters

Responses

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json