Users
GET
REST URL - https://<IP>:<port>/provapi/users SUPPORTED METHOD - GET HEADER - AuthorizationSample Request Body - Not required
Sample Response Body
[ { "userTypeId": 0, "accountId": 0, "timeFormat": "string", "description": "string", "timeZone": "string", "userEmail": "string", "isPasswordExpiryDisabled": byte, "locale": "string", "userName": "string", "userId": 0 } ]
Example
[ { "userTypeId": 1, "accountId": 1, "timeFormat": "%I", "description": "string", "timeZone": "Kolkata", "userEmail": "isradmin@oracle.com", "isPasswordExpiryDisabled": 1, "locale": "en", "userName": "Admin", "userId": 1 } ]
POST
REST URL - https://<IP>:<port>/provapi/users SUPPORTED METHOD - POST HEADER - Authorization
Path Parameter - No parameters
Sample Request Body - Create a CSV file with the following data to be
imported:
- user_name
- user_email
- description
- password
- user_type
- account_name
- login_disabled
- time_zone_locale
- audit_view_permission
- call_control_permission
- edit_recording_data_permission
- notes_and_scoring_permission
- access_to_all_routes_in_account
- time_format
Uaera imported successfully
POST
REST URL - https://<IP>:<port>/provapi/users SUPPORTED METHOD - POST HEADER - AuthorizationSample Request Body
{
"accountId": 0,
"description": "string",
"isPasswordExpiryDisabled": byte,
"locale": "string",
"loginDisabled": byte,
"timeFormat": "string",
"timeZone": "string",
"userEmail": "string",
"userName": "string",
"userPass": "string",
"userTypeId": 0
}
Sample Response Body
{ "accountId": 0, "allRoutesInAccountAccess": byte, "deletePermission": byte, "description": "string", "downloadRecordingPermission": byte, "editRecordingDataPermission": byte, "isPasswordExpiryDisabled": byte, "locale": "string", "loginDisabled": byte, "notesAndScoringPermission": byte, "playbackRecordingPermission": byte, "timeFormat": "string", "timeZone": "string", "userId": 0, "userName": "string", "userTypeId": 0, "videoAccessEnabled": byte }
Sample Input Body
{
"accountId": 1,
"description": "New user",
"isPasswordExpiryDisabled": 1,
"locale": "en",
"loginDisabled": 0,
"timeFormat": "%I",
"timeZone": "Kolkata",
"userEmail": "newUser@oracle.com",
"userName": "New User",
"userPass": "Admin1234!",
"userTypeId": 2
}
Sample Output Response
{ "userId": 14, "accountId": 1, "userName": "New User", "description": "New user", "userTypeId": 2, "loginDisabled": 0, "allRoutesInAccountAccess": 0, "deletePermission": 1, "editRecordingDataPermission": 0, "downloadRecordingPermission": 1, "playbackRecordingPermission": 1, "notesAndScoringPermission": 0, "videoAccessEnabled": 1, "timeZone": "Kolkata", "timeFormat": "%I", "locale": "en", "isPasswordExpiryDisabled": 0 }
GET
REST URL - https://<IP>:<port>/provapi/users/userName/{userName}
SUPPORTED METHOD - GET
HEADER - Authorization
PATH PARAMETER - userName
Sample Request Body - Not required
Sample Response Body
[ { "userTypeId": 0, "accountId": 0, "timeFormat": "string", "description": "string", "timeZone": "string", "userEmail": "string", "isPasswordExpiryDisabled": byte, "locale": "string", "userName": "string", "userId": 0 } ]
Sample Input URL
https://10.128.248.23:9443/provapi/users/userName/new%20User
Sample Output Response
{ "userTypeId": 2, "accountId": 1, "timeFormat": "%I", "description": "New user", "timeZone": "Kolkata", "userEmail": "newUser@oracle.com", "isPasswordExpiryDisabled": 1, "locale": "en", "userName": "New User", "userId": 14 }
DELETE
REST URL - https://<IP>:<port>/provapi/users/{userID}
SUPPORTED METHOD - DELETE
HEADER - Authorization
PATH PARAMETER - userID
Sample Request Body - Not required
Sample Response Body
User with ID <userID> has been deleted
Example
User with ID 3 has been deleted
GET
REST URL - https://<IP>:<port>/provapi/users/userID SUPPORTED METHOD - GET HEADER - Authorization PATH PARAMETER - userIDSample Request Body - Not required
Sample Response Body
[ { "userTypeId": 0, "accountId": 0, "timeFormat": "string", "description": "string", "timeZone": "string", "userEmail": "string", "isPasswordExpiryDisabled": byte, "locale": "string", "userName": "string", "userId": 0 } ]
Example
{ "userTypeId": 2, "accountId": 1, "timeFormat": "%I", "description": "New user", "timeZone": "Kolkata", "userEmail": "newUser@oracle.com", "isPasswordExpiryDisabled": 1, "locale": "en", "userName": "New User", "userId": 14 }
PATCH
REST URL - https://<IP>:<port>/provapi/users/{userID}
SUPPORTED METHOD - PATCH
HEADER - Authorization
PATH PARAMETER - userID
Sample Request Body - Any permissible key values for update
Sample Response Body
{ "accountId": 0, "allRoutesInAccountAccess": "string", "deletePermission": "string", "description": "string", "downloadRecordingPermission": "string", "editRecordingDataPermission": "string", "isPasswordExpiryDisabled": "string", "locale": "string", "loginDisabled": "string", "notesAndScoringPermission": "string", "playbackRecordingPermission": "string", "timeFormat": "string", "timeZone": "string", "userId": 0, "userName": "string", "userTypeId": 0, "videoAccessEnabled": "string" }
Sample Input Body
{
"description": "Updated desc",
"isPasswordExpiryDisabled": 1
}
Sample Output Response
{ "userId": 14, "accountId": 1, "userName": "New User", "description": "Updated desc", "userTypeId": 2, "loginDisabled": 0, "allRoutesInAccountAccess": 0, "deletePermission": 1, "editRecordingDataPermission": 0, "downloadRecordingPermission": 1, "playbackRecordingPermission": 1, "notesAndScoringPermission": 0, "videoAccessEnabled": 1, "timeZone": "Kolkata", "timeFormat": "%I", "locale": "en", "isPasswordExpiryDisabled": 1 }
PUT
REST URL - https://<IP>:<port>/provapi/users/userID SUPPORTED METHOD - PUT HEADER - Authorization PATH PARAMETER - userIDSample Request Body
{
"accountId": 0,
"allRoutesInAccountAccess": byte,
"deletePermission": byte,
"description": "string",
"downloadRecordingPermission": byte,
"editRecordingDataPermission": byte,
"isPasswordExpiryDisabled": byte,
"locale": "string",
"loginDisabled": byte,
"notesAndScoringPermission": byte,
"playbackRecordingPermission": byte,
"timeFormat": "string",
"timeZone": "string",
"userId": 0,
"userName": "string",
"userTypeId": 0,
"videoAccessEnabled": byte
}
Sample Response Body
{ "accountId": 0, "allRoutesInAccountAccess": "byte", "deletePermission": byte, "description": "string", "downloadRecordingPermission": byte, "editRecordingDataPermission": byte, "isPasswordExpiryDisabled": byte, "locale": "string", "loginDisabled": byte, "notesAndScoringPermission": byte, "playbackRecordingPermission": byte, "timeFormat": "string", "timeZone": "string", "userId": 0, "userName": "string", "userTypeId": 0, "videoAccessEnabled": byte }
Sample Input Body
{ "userId": 14, "accountId": 1, "userName": "New User", "description": "updated user", "userTypeId": 2, "loginDisabled": 0, "allRoutesInAccountAccess": 0, "deletePermission": 1, "editRecordingDataPermission": 0, "downloadRecordingPermission": 1, "playbackRecordingPermission": 1, "notesAndScoringPermission": 0, "videoAccessEnabled": 1, "timeZone": "Kolkata", "timeFormat": "%I", "locale": "en", "isPasswordExpiryDisabled": 0 }
Sample Output Response
{ "userId": 14, "accountId": 1, "userName": "New User", "description": "updated user", "userTypeId": 2, "loginDisabled": 0, "allRoutesInAccountAccess": 0, "deletePermission": 1, "editRecordingDataPermission": 0, "downloadRecordingPermission": 1, "playbackRecordingPermission": 1, "notesAndScoringPermission": 0, "videoAccessEnabled": 1, "timeZone": "Kolkata", "timeFormat": "%I", "locale": "en", "isPasswordExpiryDisabled": 0 }
DELETE
REST URL - https://<IP>:<port>/provapi/users/{userID}/userAccount/{accountID}
SUPPORTED METHOD - DELETE
HEADER - Authorization
PATH PARAMETER - userID,accountID
Sample Request Body - Not required
Sample Response Body
User account with ID <accountID> is deleted
Sample Input URL
https://10.128.248.23:9443/provapi/users/2/userAccount/3
Sample Output Response
User account with ID 3 is deleted
PUT
REST URL - https://<IP>:<port>/provapi/users/{userID}/userAccount/{accountID}
SUPPORTED METHOD - PUT
HEADER - Authorization
PATH PARAMETER - userID, accountID
Sample Request Body - Not required
Sample Response Body
{ "allRoutesInAccountAccess": "string", "userAccountIdentity": { "accountId": 0, "userId": 0 } }
Sample Input URL
https://10.128.248.23:9443/provapi/users/2/userAccount/3
Sample Output Response
{ "allRoutesInAccountAccess": 1, "userAccountIdentity": { "accountId": 3, "userId": 2 } }
DELETE
REST URL - https://<IP>:<port>/provapi/users/{userID}/userRoute/{userRouteID}
SUPPORTED METHOD - DELETE
HEADER - Authorization
PATH PARAMETER - userID, userRoute
Sample Request Body - Not required
Sample Response Body
User route with ID <userRouteID> is deleted
Sample Input URL
https://10.128.248.23:9443/provapi/users/2/userRoute/3
Sample Output Response
User routewith ID 3 is deleted
PUT
REST URL - https://<IP>:<port>/provapi/users/{userID}/userRoute/{userRouteID}
SUPPORTED METHOD - PUT
HEADER - Authorization
PATH PARAMETER - userID, routeID
Sample Request Body - Not required
Sample Response Body
{ "userRoutesIdentity": { "routeId": 0, "userId": 0 } }
Sample Input URL
https://10.128.248.23:9443/provapi/users/2/userRoute/3
Sample Output Response
{ "userRoutesIdentity": { "routeId": 3, "userId": 2 } }
