Access rights service

Retrieves user and workstation access rights information.

Users

Returns a list of all the users in IPS. For each user the following information is returned:

User characteristics
List of IPS user groups to which the user belongs

Access to this method is authorized by the Get Access Rights operation.

Securityips_token

Request

query Parameters

UserPid

number

User PID, must be a number if specified. If not specified, all users are returned.

Responses

200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/AccessRightsService.svc/rest/users

Response samples

application/json

{"Users": [{"UserPid": 1,
"UserFid": "WebAdmin",
"UserName": "WebAdmin",
"UserType": 2,
"UserAccreditation": null,
"OwnOfficeFcd": "PLLUNA",
"ValidInd": 3,
"IpsWeb": "Y",
"EmailAddress": null,
"UserDomain": "ORGANISATION",
"UserGroups": [{"UserGroupId": "DEFAULT"
}
]
}
]
}

User groups

Returns a list of all IPS user groups. For each user group the following information is returned

User group characteristics
List of IPS users who belong to this group
List of all functions to which this group has access

Access to this method is authorized by the Get Access Rights operation.

Note that all user groups are returned (even user groups without any users or access to any functions).

Securityips_token

Request

query Parameters

UserGroupId

string

User group ID. If not specified, all user groups are returned.

Responses

200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/AccessRightsService.svc/rest/usergroups

Response samples

application/json

{"UserGroups": [{"UserGroupId": "DEFAULT",
"UserGroupName": "Default User Group",
"Users": [{"UserPid": 1
}
],
"Functions": [{"FunctionId": 7116
}
]
}
]
}

Workstations

Returns a list of all the workstations in IPS. For each workstation the following information is returned.

Workstation characteristics
List of IPS workstation groups to which the workstation belongs

Access to this method is authorized by the Get Access Rights operation.

Note that all workstations are returned (even workstations without access to any group).

Securityips_token

Request

query Parameters

WorkstationPid	number Workstation PID, must be a number if specified. If not specified a WorkstationFid and/or a WorkstationDomain must be specified.
WorkstationFid	string Workstation FID can be specified in combination with the WorkstationDomain. Returns all workstation information of workstations with this FID
WorkstationDomain	string The organisational domain the workstation is part of. It can be specified in combination with the WorkstationFid. Returns all workstations registered in this domain.

Responses

200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/AccessRightsService.svc/rest/workstations

Response samples

application/json

{"Workstations": [{"WorkstationPid": 3,
"WorkstationFid": "PC10117027",
"WorkstationDomain": "INTERNAL",
"ValidInd": 3,
"WorkstationGroups": [{"WorkstationGroupId": "DEFAULT"
}
],
"Configuration": [{"Key": "TheKey",
"Value": "TheValue"
}
]
}
]
}

Workstation groups

Returns a list of all IPS workstation groups. For each workstation group the following information is returned:

Workstation group characteristics
List of IPS workstations who belong to this group
List of all functions to which this group has access

Access to this method is authorized by the Get Access Rights operation.

Note that all workstation groups are returned (even workstation groups without any workstations or access to any functions).

Securityips_token

Request

query Parameters

WorkstationGroupId

string

Workstation Group ID. If not specified, all workstation groups are returned

Responses

200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/AccessRightsService.svc/rest/workstationgroups

Response samples

application/json

{"WorkstationGroups": [{"WorkstationGroupId": "string",
"WorkstationGroupName": "string",
"Workstations": [{"WorkstationPid": 0
}
],
"Functions": [{"FunctionId": 0
}
]
}
]
}

Functions

Returns a list of IPS functions. For each function the following information is returned

Function characteristics
List of all user groups which have access to the function
List of all workstation groups which have access to the function

Access to this method is authorized by the Get Access Rights operation.

Note that all functions are returned (even functions to which no user group or workstation group has access).

Securityips_token

Request

query Parameters

FunctionId

number

Function ID, must be a number if specified. If not specified, all functions are returned.

Responses

200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/AccessRightsService.svc/rest/functions

Response samples

application/json

{"Functions": [{"FunctionId": 0,
"FunctioFid": "string",
"FunctionNm": "string",
"WorkstationsGroups": [{"WorkstationGroupId": "string"
}
],
"UsersGroups": [{"UserGroupId": "string"
}
],
"Translations": [{"LanguageCD": "FR",
"Translation": "Violà la traduction en français"
}
]
}
]
}

➔ Next to Accounting dispatch service