The body payload comprises of the metadata about the user to be updated. - The body parameter refers to the format of the request, the request body (payload) takes the following media types to make the payload:
JSON
request*UserLoginIdRequest
Response
OK ! Successful operation. The requested operation was successfully executed.
This API is used to assign roles to a user. It can also be used to replace and remove already assigned user roles. If a user should not be assigned any role in the organization, pass the role paramater as an empty array.
The endpoint for Accepting User T&C* is /user/v1/tnc/accept
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
This API is used to assign roles to a user. It can also be used to replace and remove already assigned user roles. If a user should not be assigned any role in the organization, pass the role paramater as an empty array.
The endpoint for Assign Role to User is /user/v1/role/assign
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
The body payload comprises of the metadata about the user to be updated. - The body parameter refers to the format of the request, the request body (payload) takes the following media types to make the payload:
JSON
request*UserUpdateReqV1
Response
OK ! Successful operation."Update User" operation was successfully executed.
This API is used to assign roles to a user. It can also be used to replace and remove already assigned user roles. If a user should not be assigned any role in the organization, pass the role paramater as an empty array.
The endpoint for Assign Role to User is /user/v2/role/assign
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
The body payload comprises of the metadata of the user being created - The body parameter refers to the format of the request, the request body (payload) takes the following media types to make the payload:
The body payload comprises of the metadata about the user to be updated. - The body parameter refers to the format of the request, the request body (payload) takes the following media types to make the payload:
JSON
request*UserUpdateReqV1
Response
OK ! Successful operation."Update User V2" operation was successfully executed.
The body payload comprises of the metadata about the user to be updated. - The body parameter refers to the format of the request, the request body (payload) takes the following media types to make the payload:
JSON
request*UserUpdateReqV1
Response
OK ! Successful operation."Update User V3" operation was successfully executed.
The body payload comprises of the metadata about unblocking a user request - The body parameter refers to the format of the request, the request body (payload) takes the following media types to make the payload:
JSON
request*UserBlockRequest
Response
OK ! Successful operation."Unblocking User" operation was successfully executed.
The body payload comprises of the metadata to migrate a user request - The body parameter refers to the format of the request, the request body takes the following media types to make the payload:
JSON
request*MigrateUserReq
Response
OK ! Successful operation. "User migration" operation was successfully executed.
The body payload comprises of the metadata of the user being created - The body parameter refers to the format of the request, the request body (payload) takes the following media types to make the payload:
The body payload comprises of the metadata of the user being created - The body parameter refers to the format of the request, the request body (payload) takes the following media types to make the payload:
The body payload comprises of the metadata of the user being created - The body parameter refers to the format of the request, the request body (payload) takes the following media types to make the payload:
The body payload comprises of the metadata of the user being created - The body parameter refers to the format of the request, the request body (payload) takes the following media types to make the payload:
JSON
request*User Request V2 Object
Response
OK ! Successful operation."Create User" operation was successfully executed.
This API is used for searching a specific user, the user search is based on the unique ID of the user
The endpoint for Get User by User ID is /user/v4/read/{User_ID}
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles,locations
'completeness' is to return profile completeness percentage.
'missingFields' is to return fields that are missing to achieve 100% profile completeness.
'topic' is to return list of topics that are used for announcements.
'organisations' is to return organisation and location details.
'roles' is to return list of roles with name and ID details.
This API is used for searching a specific user, the user search is based on the unique ID of the user
The endpoint for Get User by User ID is /user/v1/read/{User_ID}
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles
'completeness' is to return profile completeness percentage.
'missingFields' is to return fields that are missing to achieve 100% profile completeness.
'topic' is to return list of topics that are used for announcements.
'organisations' is to return organisation and location details.
'roles' is to return list of roles with name and ID details.
This API is used for searching a specific user, the user search is based on the unique ID of the user
The endpoint for Get User by User ID v2 is /user/v2/read/{User_ID}
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles
'completeness' is to return profile completeness percentage.
'missingFields' is to return fields that are missing to achieve 100% profile completeness.
'topic' is to return list of topics that are used for announcements.
'organisations' is to return organisation and location details.
'roles' is to return list of roles with name and ID details.
Only necessary fields are returned in the response as per user profile configuration.
Please append a valid User Id To the Request URI and if user need any specific values like , profile completeness ,missingFields,topic Ex: ?Fields=completeness,missingFields,topic
Header parameters
Response
OK ! Successful operation."Get User by User ID v2" operation was successfully executed.
This API is used for searching a specific user, the user search is based on the unique ID of the user
The endpoint for Get User by User ID is /user/v5/read/{User_ID}
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles,locations
'completeness' is to return profile completeness percentage.
'missingFields' is to return fields that are missing to achieve 100% profile completeness.
'topic' is to return list of topics that are used for announcements.
'organisations' is to return organisation and location details.
'roles' is to return list of roles with name and ID details.
This API is used for reading a specific user, the user read is based on the unique ID of the user
The endpoint for Get User by User ID v3 is /user/v3/read/{User_ID}
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles,tokens
'completeness' is to return profile completeness percentage.
'missingFields' is to return fields that are missing to achieve 100% profile completeness.
'topic' is to return list of topics that are used for announcements.
'organisations' is to return organisation and location details.
'roles' is to return list of roles with name and ID details.
MUA user detail can be retreived with their token details
Please append a valid User Id To the Request URI and if user need any specific values like , profile completeness ,missingFields,topic Ex: ?Fields=completeness,missingFields,topic
Query parameters
Header parameters
Response
OK ! Successful operation."Get User by User ID v3" operation was successfully executed.
This API is used to create a user - The endpoint for Create User V1 is /user/v1/create - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
The body payload comprises of the metadata of the user being created - The body parameter refers to the format of the request, the request body (payload) takes the following media types to make the payload:
JSON
request*User Request Object
Response
OK ! Successful operation."Create User" operation was successfully executed.