GET /user-ms/micollab/fetchRoles

Fetch MiCollab roles. Only Admin users can use this request.

To retrieve all MiCollab roles:

  1. Perform the authentication and login to the API. For more information, see POST /auth/login.

  2. Use GET /user-ms/micollab/fetchRoles to send an HTTP GET request.

  3. Click Try it Out option.

  4. Set the parameters as listed in the following table.

    Parameter Name

    Sample Value

    Supported Value

    Description

    miCollabsubsystem

    miCollabsubsystem

    string

    Indicates the MiCollab subsystem.

    Note:

    This parameter is mandatory.

    extensionLIMIP

    extensionLIMIP

    string
    Indicates the network element IP (Extension LIM IP).
    Note:

    This parameter is mandatory.

    mxoneSubsysIP

    mxoneSubsysIP

    string
    Indicates the MXONE subsystem IP.
    Note:

    This parameter is mandatory.

  5. Click on Execute to generate the request URL.

    Request URL:
    https://<IP_Address>:<PORT>/user-ms/micollab/fetchRoles?miCollabsubsystem=1&extensionLIMIP=1&mxoneSubsysIP=1
    The following table lists the expected responses.

    Response Type

    Value

    Schema

    Valid Response

    200 OK

    		 
    [
  {
    "roles": [
      "string"
    ],
    "idsConnection": "string"
  }
]

    Error Response

    400 Bad Request

    Not applicable

    401 Authentication Failure

    Not applicable

    403 Forbidden

    Not applicable

    404 Not found

    Not applicable
Parent topic: MiCollab
↑