{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book Users API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List User(s)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/user",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "filter",
                "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"",
                "type": "query",
                "description": "Specify a filter based on which the results will be fetched. Supported filterable fields:  id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see  <a href=\"https://www.here.com/docs/bundle/data-client-library-developer-guide-java-scala/page/client/rsql.html\">this reference</a>. For a list of supported operators, see <a href=\"https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference\">this syntax guide</a>.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n"
              },
              {
                "name": "attributes",
                "value": "id",
                "type": "query",
                "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported."
              },
              {
                "name": "page",
                "value": "0",
                "type": "query",
                "description": "Defines the number of displayed page. The page number starts from 0."
              },
              {
                "name": "pageSize",
                "value": "100",
                "type": "query",
                "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size."
              },
              {
                "name": "singleObjectResponse",
                "value": "",
                "type": "query",
                "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception."
              }
            ]
          },
          "docs": "Retrieve a list of User(s) in a given organization."
        },
        {
          "info": {
            "name": "Bulk partial update Users",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/organization/:orgid/user/bulk",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update some or all properties for multiple users in bulk for a given organization."
        },
        {
          "info": {
            "name": "Bulk update User dynamic skills",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/organization/:orgid/user/bulk/update-dynamic-skill/:skillId",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "skillId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the skill."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Assign or unassign a dynamic skill to/from multiple users in bulk for a given organization."
        },
        {
          "info": {
            "name": "Get specific User by CI User ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "id",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
                "type": "path",
                "description": "CI ID of the User."
              },
              {
                "name": "includeUserProfile",
                "value": "true",
                "type": "query",
                "description": "Specifiy whether to include user profile data"
              }
            ]
          },
          "docs": "Retrieve an existing User using the CI ID  in a given organization."
        },
        {
          "info": {
            "name": "Get users by dynamic skill ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/user/by-dynamic-skill-id/:skillId",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "skillId",
                "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0",
                "type": "path",
                "description": "The dynamic skill ID to fetch users for"
              },
              {
                "name": "search",
                "value": "contact center",
                "type": "query",
                "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email, value)\n\nThe examples below show some search queries\n- \"Cisco\"\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Defines the number of displayed page. The page number starts from 0."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size."
              }
            ]
          },
          "docs": "Fetches all users assigned to a specific dynamic skill with search and pagination support. Returns user details with the specific dynamic skill value."
        },
        {
          "info": {
            "name": "Get the agents matching skill requirements criteria",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "search",
                "value": "contact center",
                "type": "query",
                "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n"
              },
              {
                "name": "page",
                "value": "0",
                "type": "query",
                "description": "Defines the number of displayed page. The page number starts from 0."
              },
              {
                "name": "pageSize",
                "value": "100",
                "type": "query",
                "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API can be used to fetch the agents who match the provided skill requirements criteria. Maximum of 50 skill requirements criteria can be passed in the request."
        },
        {
          "info": {
            "name": "Fetch User details by IDs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Defines the number of displayed page. The page number starts from 0."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Retrieve an existing User's first name, last name and email by list of IDs in a given organization."
        },
        {
          "info": {
            "name": "List Users along with profile",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/user/with-user-profile",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              }
            ]
          },
          "docs": "Retrieve a list of User(s) along with their UserProfiles in a given organization."
        },
        {
          "info": {
            "name": "Get specific User along with profile by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "id",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
                "type": "path",
                "description": "Resource ID of the User."
              }
            ]
          },
          "docs": "Retrieve an existing User along with the corresponding UserProfile by ID in a given organization."
        },
        {
          "info": {
            "name": "Get specific User by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/user/:id",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "id",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
                "type": "path",
                "description": "Resource ID of the User."
              },
              {
                "name": "includeCount",
                "value": "",
                "type": "query",
                "description": "If set to true, the API response will include the count of each type of Contact Service Queues that the user is assigned to"
              },
              {
                "name": "includeUserProfileType",
                "value": "",
                "type": "query",
                "description": "If set to true, the API response will include the user profile"
              },
              {
                "name": "includeSkillProfileAudit",
                "value": "",
                "type": "query",
                "description": "If set to true gives skill profile modification info."
              },
              {
                "name": "includeReskillAuditInfo",
                "value": "",
                "type": "query",
                "description": "If set to true gives skill profile and dynamic skill modification info."
              },
              {
                "name": "includeSkillDetails",
                "value": "",
                "type": "query",
                "description": "If set to true,the response includes skill information for each dynamic skill assignment"
              }
            ]
          },
          "docs": "Retrieve an existing Users by ID in a given organization."
        },
        {
          "info": {
            "name": "Update specific User by ID",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/organization/:orgid/user/:id",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "id",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
                "type": "path",
                "description": "Resource ID of the User."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing User by ID in a given organization."
        },
        {
          "info": {
            "name": "Partially update User by ID",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/organization/:orgid/user/:id",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "id",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
                "type": "path",
                "description": "Resource ID of the User."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Partially update User by ID in a given organization."
        },
        {
          "info": {
            "name": "List references for a specific User",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "id",
                "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0",
                "type": "path",
                "description": "ID of this contact center resource."
              },
              {
                "name": "type",
                "value": "type_text",
                "type": "query",
                "description": "Entity type of the other entity that has a reference to this specific entity."
              },
              {
                "name": "page",
                "value": "0",
                "type": "query",
                "description": "Defines the number of displayed page. The page number starts from 0."
              },
              {
                "name": "pageSize",
                "value": "100",
                "type": "query",
                "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size."
              }
            ]
          },
          "docs": "Retrieve a list of all entities that have reference to an existing User by ID in a given organization."
        },
        {
          "info": {
            "name": "Reskill Agents",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/organization/:orgid/user/:id/reskill",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "id",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
                "type": "path",
                "description": "Resource ID of the User."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Reskill agents by assigning or unassigning skills."
        },
        {
          "info": {
            "name": "List User(s)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/v2/user",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "filter",
                "value": "id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"",
                "type": "query",
                "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see  <a href=\"https://www.here.com/docs/bundle/data-client-library-developer-guide-java-scala/page/client/rsql.html\">this reference</a>. For a list of supported operators, see <a href=\"https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference\">this syntax guide</a>.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n"
              },
              {
                "name": "attributes",
                "value": "id",
                "type": "query",
                "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported."
              },
              {
                "name": "search",
                "value": "contact center",
                "type": "query",
                "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n"
              },
              {
                "name": "page",
                "value": "0",
                "type": "query",
                "description": "Defines the number of displayed page. The page number starts from 0."
              },
              {
                "name": "pageSize",
                "value": "100",
                "type": "query",
                "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size."
              },
              {
                "name": "supervisorManagedAgentsOnly",
                "value": "",
                "type": "query",
                "description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams."
              },
              {
                "name": "singleObjectResponse",
                "value": "",
                "type": "query",
                "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception."
              },
              {
                "name": "buddyTeamAgentsOnly",
                "value": "",
                "type": "query",
                "description": "If set to true, returns only users who are part of buddy teams without PBAC check."
              },
              {
                "name": "userInQueue",
                "value": "",
                "type": "query",
                "description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor."
              },
              {
                "name": "queueId",
                "value": "",
                "type": "query",
                "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched."
              },
              {
                "name": "includeAIMappingCount",
                "value": "",
                "type": "query",
                "description": "If set to true, the API response will include the count of each AI features mapped to the entity."
              },
              {
                "name": "includeDynamicSkillsLimitReached",
                "value": "",
                "type": "query",
                "description": "If true, includes whether each user has reached the dynamic skills assignment limit."
              }
            ]
          },
          "docs": "Retrieve a list of User(s) in a given organization."
        },
        {
          "info": {
            "name": "Get specific User by CI User ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "id",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
                "type": "path",
                "description": "CI ID of the User."
              },
              {
                "name": "includeUserProfile",
                "value": "true",
                "type": "query",
                "description": "Specifiy whether to include user profile data"
              },
              {
                "name": "includeNames",
                "value": "true",
                "type": "query",
                "description": "Specifiy whether to include resource collection names"
              }
            ]
          },
          "docs": "Retrieve an existing User using the CI ID  in a given organization."
        }
      ]
    }
  ],
  "bundled": true
}