Loading

Admin Management Service (v1)

Download OpenAPI specification:Download

AuditContext

Generate audit context Deprecated

Generates a new audit context identifier which tracks 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 Basic/Bearer Auth token

Request Body schema:

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>

The list of the person ids involved in changes under audit. It can be null if no person is involved, e.g. registering contact.

Createdby
string

The app name which creates the audit context. If it is not provided then will be replaced with tenant name.

AuthorizedAppId
string

The application that was authorized to contact the services.

Responses

200

Successfully generated audit context identifier

422

Couldn't process the request

500

Internal server error

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

Request samples

Content type
Copy
Expand all Collapse all
{
  • "PersonIds":
    [
    ],
  • "Createdby": "backoffice",
  • "AuthorizedAppId": "jGER285mdgZuDq50PadB1ITWv3tM9Y"
}

Generate audit context

Generates a new audit context identifier which tracks 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 Basic/Bearer Auth token

Request Body schema:

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>

The list of the person ids involved in changes under audit. It can be null if no person is involved, e.g. registering contact.

Createdby
string

The app name which creates the audit context. If it is not provided then will be replaced with tenant name.

AuthorizedAppId
string

The application that was authorized to contact the services.

Responses

200

Successfully generated audit context identifier

422

Couldn't process the request

500

Internal server error

post/v1.1/auditcontext/generate
https://example-host/v1.1/auditcontext/generate

Request samples

Content type
Copy
Expand all Collapse all
{
  • "PersonIds":
    [
    ],
  • "Createdby": "backoffice",
  • "AuthorizedAppId": "jGER285mdgZuDq50PadB1ITWv3tM9Y"
}

Response samples

Content type
Copy
Expand all Collapse all
{
  • "AuditContextId": 1001,
  • "TenantId": 2,
  • "TenantKey": "Additiv",
  • "MemberIds":
    [
    ]
}

Generate audit context for a specific tenant

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

path Parameters
tenantKey
required
string

The tenant key

header Parameters
Authorization
string

The Basic/Bearer Auth token

Request Body schema:

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.

InternalIds
Array of strings <uuid>

The list of the internal ids involved in changes under audit.

Createdby
string

The app name which creates the audit context. If it is not provided then will be replaced with tenant name.

AuthorizedAppId
string

The application that was authorized to contact the services.

Responses

200

Successfully generated audit context identifier

422

Couldn't process the request

500

Internal server error

post/v2.0/tenants/{tenantKey}/auditcontext/generate
https://example-host/v2.0/tenants/{tenantKey}/auditcontext/generate

Request samples

Content type
Copy
Expand all Collapse all
{
  • "InternalIds":
    [
    ],
  • "Createdby": "backoffice",
  • "AuthorizedAppId": "jGER285mdgZuDq50PadB1ITWv3tM9Y"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "AuditContextId": 1001,
  • "TenantId": 2,
  • "TenantKey": "Additiv",
  • "MemberIds":
    [
    ]
}

IdentityRoleHierarchy

Get all roles

Get all the roles with hierarchy level (rank) information

header Parameters
Authorization
string

The Basic/Bearer Auth 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
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get all the tenant policy members

header Parameters
Authorization
string

The Basic/Bearer Auth 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
[
  • {
    },
  • {
    }
]

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 Basic/Bearer Auth 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":
    {
    },
  • "HierarchyItems":
    [
    ]
}

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 Basic/Bearer Auth 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":
    [
    ],
  • "Base":
    {
    },
  • "HierarchyItems":
    [
    ]
}

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 Basic/Bearer Auth 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 Basic/Bearer Auth token

Request Body schema:

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

Content type
Copy
Expand all Collapse all
[
  • 0
]

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 Basic/Bearer Auth token

Request Body schema:

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

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 Basic/Bearer Auth token

Request Body schema:

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

PersonId
integer <int32>

The ID of the Person which will be checked whether is in the hierarchy of a member.

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

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 Basic/Bearer Auth token

Request Body schema:

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

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":
    [
    ],
  • "TotalCount": 2
}

Syncs member data in the tenant database based of the information of the identity.

path Parameters
tenantKey
required
string

The tenant key

internalUserId
required
string <uuid>

The global unique identifier of the identity which will map the member.

header Parameters
Authorization
string

The Basic/Bearer Auth token

Request Body schema:

The synch member request

Member
object (additiv.Services.Admin.Service.Contracts.SyncMember)
Context
object (additiv.Services.Admin.Service.Contracts.AuditContextBase)

Responses

200

Successfully synced member in tenant database

404

Couldn't find the identity user

422

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

post/v2.0/tenants/{tenantKey}/members/{internalUserId}/sync
https://example-host/v2.0/tenants/{tenantKey}/members/{internalUserId}/sync

Request samples

Content type
Copy
Expand all Collapse all
{
  • "Member":
    {
    },
  • "Context":
    {
    }
}

Response samples

Content type
Copy
Expand all Collapse all
{
  • "InternalUserId": "f4f751e4-50a2-4c71-8dd6-bb3e963cf738",
  • "MemberId": 11,
  • "AuditContextId": 1001
}