The Identities group allows for identities to be added, updated, or deleted. Operations in this section include:
Description Add an identity
Response Class
ResponseStatus {
ErrorCode (string, optional),
Message (string, optional),
StackTrace (string, optional),
Errors (Array[ResponseError], optional)
}
ResponseError {
ErrorCode (string, optional),
FieldName (string, optional),
Message (string, optional)
}
Parameter | Description | Data Type |
---|---|---|
RequestorEmployeeNumber | Requestors Employee Number | string |
FirstName | First Name | string |
MiddleName | Middle Name | string |
LastName | Last Name | string |
Gender | Gender | string |
PrimaryEmailAddress | Primary Email Address | string |
PrimaryEmailType | Primary Email Type | string |
PrimaryPhoneNumber | Primary Phone Number | string |
PrimaryPhoneType | Primary Phone Type | string |
PrimaryPhoneExtension | Primary Phone Extension | string |
SecondaryPhoneNumber | Secondary Phone Number | string |
SecondaryPhoneType | Secondary Phone Type | string |
SecondaryPhoneExtension | Secondary Phone Extension | string |
TitlePrefix | Title Prefix | string |
TitleSuffix | Title Suffix | string |
Title | Title | string |
BuildingIdentifier | Valid Building Identifier | string |
Company | Valid Company name | string |
EmployeeType | Employee Type | string |
EmployeeCategory | Employee Category | string |
EmployeeNumber | Employee Number | string |
ManagerEmployeeNumber | Manager Employee Number | string |
Department | Department | string |
Floor | Floor | string |
StartDate | Start Date | string |
ExpirationDate | Expiration Date | string |
DateOfBirth | Date Of Birth | string |
Photo | photo as a Base64 string | string |
Description Grant access groups to an Identity
Parameter | Description | Data Type |
---|---|---|
EmployeeNumber | Employee Number | string |
RequestorEmployeeNumber | Requestor Employee Number | string |
ManagedByEmployeeNumber | Managed By Employee Number | string |
GrantedAccessGroups | List of access groups to grant | string |
Business Justification | Business Justification | string |
Description Grant access groups to an Identity
Parameter | Description | Data Type |
---|---|---|
EmployeeNumber | Employee Number | string |
RequestorEmployeeNumber | Requestor Employee Number | string |
AccessGroups | Accessgroups to assign | string |
Description Grant access groups to an Identity
Response Class
UploadPhotoResponse {
Id (Guid),
AbsoluteUri (string),
IsNewImage (boolean)
}
Guid {}
Parameter | Description | Data Type |
---|---|---|
EmployeeNumber | Employee Number | string |
Photo | Photo as a Base64 string | string |
Tag | Simple label to help employee where photo came from | string |
Description Grant role
Parameter | Description | Data Type |
---|---|---|
EmployeeNumber | Employee Number | string |
Role | Role | string |
Securable | Securable for Guest and IDM | Securable[] |
ConnectAcrmEmployeeNumber | Acrm’s Employee Number | string |
ConnectManagedAccessGroups | Accessgroups to manage | Guid[] |
RequestorEmployeeNumber | Requestors Employee Number | string |
Description Update Identity
Parameter | Description | Data Type |
---|---|---|
RequestorEmployeeNumber | Requestors Employee Number | string |
FirstName | First Name | string |
MiddleName | Middle Name | string |
LastName | Last Name | string |
Gender | Gender | string |
PrimaryEmailAddress | Primary Email Address | string |
PrimaryEmailType | Primary Email Type | string |
PrimaryPhoneNumber | Primary Phone Number | string |
PrimaryPhoneType | Primary Phone Type | string |
PrimaryPhoneExtension | Primary Phone Extension | string |
SecondaryPhoneNumber | Secondary Phone Number | string |
SecondaryPhoneType | Secondary Phone Type | string |
SecondaryPhoneExtension | Secondary Phone Extension | string |
TitlePrefix | Title Prefix | string |
TitleSuffix | Title Suffix | string |
Title | Title | string |
BuildingIdentifier | Valid Building Identifier | string |
Company | Valid Company name | string |
EmployeeType | Employee Type | string |
EmployeeCategory | Employee Category | string |
EmployeeNumber | Employee Number | string |
ManagerEmployeeNumber | Manager Employee Number | string |
Department | Department | string |
Location | Location | string |
Floor | Floor | string |
StartDate | Start Date | string |
ExpirationDate | Expiration Date | string |
DateOfBirth | Date Of Birth | string |
Photo | photo as a Base64 string | string |
Description Change identity Acrm when Identity is an ACR
Parameter | Description | Data Type |
---|---|---|
RequestorEmployeeNumber | Requestors Employee Number | string |
EmployeeNumber | Employee Number | string |
Description Assign manager
Parameter | Description | Data Type |
---|---|---|
RequestorEmployeeNumber | Requestors Employee Number | string |
EmployeeNumber | Employee Number | string |
ManagerEmployeeNumber | Manager Employee Number | string |
Description Terminate Identity
Parameter | Description | Data Type |
---|---|---|
RequestorEmployeeNumber | Requestors Employee Number | string |
EmployeeNumber | Employee Number | string |
Description Reverse Identity termination
Parameter | Description | Data Type |
---|---|---|
RequestorEmployeeNumber | Requestors Employee Number | string |
EmployeeNumber | Employee Number | string |
Description Delete Identity
Parameter | Description | Data Type |
---|---|---|
RequestorEmployeeNumber | Requestors Employee Number | string |
EmployeeNumber | Employee Number | string |
Description Revoke Accessgroups from an Identity
Parameter | Description | Data Type |
---|---|---|
RequestorEmployeeNumber | Requestors Employee Number | string |
EmployeeNumber | Employee Number | string |
AccessGroups | List of Access groups to revoke | string |
Description Unassign accessgroups to manage
Parameter | Description | Data Type |
---|---|---|
RequestorEmployeeNumber | Requestors Employee Number | string |
EmployeeNumber | Employee Number | string |
AccessGroups | List of Access groups to revoke | string |
Description Unassign manager
Parameter | Description | Data Type |
---|---|---|
RequestorEmployeeNumber | Requestors Employee Number | string |
EmployeeNumber | Employee Number | string |
ManagerEmployeeNumber | Manager Employee Number | string |
Description Revoke role
Parameter | Description | Data Type |
---|---|---|
RequestorEmployeeNumber | Requestors Employee Number | string |
EmployeeNumber | Employee Number | string |
Role | Role | string |
Description Get Identity
Response Class
Identity {
Id (Guid),
FirstName (string),
LastName (string),
EmployeeNumber (string),
Email (string),
Roles (string),
AcrmEmployeeNumber (string),
ManagersEmployeeNumber (string)
}
Guid {}
Parameter | Description | Data Type |
---|---|---|
EmployeeNumber | Employee Number | string |
Description Get access groups for an identity
Response Class
AccessGroup {
Id (Guid),
Name (string),
Description (string),
IsAutoApproved (boolean)
}
Guid {}
Parameter | Description | Data Type |
---|---|---|
EmployeeNumber | Employee Number | string |
Description Get Acrs for an Identity Acrm
Response Class
IdentityAcr {
EmployeeNumber (string),
FirstName (string),
LastName (string)
}
Parameter | Description | Data Type |
---|---|---|
EmployeeNumber | Employee Number | string |
RequestorEmployeeNumber | Requestor Employee Number | string |
Description Get managed accessgroups
Response Class
ResponseStatus {
ErrorCode (string, optional),
Message (string, optional),
StackTrace (string, optional),
Errors (Array[ResponseError], optional)
}
ResponseError {
ErrorCode (string, optional),
FieldName (string, optional),
Message (string, optional)
}
Parameter | Description | Data Type |
---|---|---|
EmployeeNumber | Employee Number | string |
RequestorEmployeeNumber | Requestor Employee Number | string |
Description Get Identity Roles
Response Class
RoleSecurables {
Role (string) = ['IDMSysAdmin' or 'IDMBuildingManager' or 'IDMSecurityManager' or 'IDMReportViewer' or 'IDMTenantManager' or 'GuestAdmin' or 'GuestHost' or 'GuestHostDelegate' or 'GuestReceptionist' or 'GuestReportViewer' or 'ConnectAdmin' or 'ConnectAcrm' or 'ConnectAcr' or 'ConnectPhotoAdmin' or 'ConnectPhotoTech' or 'ConnectReportAdmin' or 'ConnectAcrAdmin'],
Securables (Array[Securable])
}
Securable {
BuildingIdentifier (string),
Company (string)
}
Parameter | Description | Data Type |
---|---|---|
EmployeeNumber | Employee Number | string |