{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book User Profiles API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "User Profiles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List references for a specific User Profile",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/user-profile/: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 profile by ID in a given organization."
        },
        {
          "info": {
            "name": "List user profiles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/v3/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."
              },
              {
                "name": "filter",
                "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"",
                "type": "query",
                "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, 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. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)"
              },
              {
                "name": "search",
                "value": "contact center",
                "type": "query",
                "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");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."
              }
            ]
          },
          "docs": "Retrieve a list of user profiles in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API."
        },
        {
          "info": {
            "name": "Create a new User Profile",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/organization/:orgid/v3/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."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new user profile in a given organization."
        },
        {
          "info": {
            "name": "Bulk save User Profiles",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/organization/:orgid/v3/user-profile/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": "Create, Update or delete user profiles in bulk in a given organization."
        },
        {
          "info": {
            "name": "Get specific User Profile by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/v3/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 Profile."
              },
              {
                "name": "includeNames",
                "value": "true",
                "type": "query",
                "description": "Flag to include resource names in the response."
              }
            ]
          },
          "docs": "Retrieve an existing user profile by ID in a given organization."
        },
        {
          "info": {
            "name": "Update specific User Profile by ID",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/organization/:orgid/v3/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 Profile."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing user profile by ID in a given organization."
        },
        {
          "info": {
            "name": "Delete specific User Profile by ID",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/organization/:orgid/v3/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 Profile."
              }
            ]
          },
          "docs": "Delete an existing user profile by ID in a given organization."
        },
        {
          "info": {
            "name": "Get specific User Profile ACL by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl",
            "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 Profile."
              },
              {
                "name": "names",
                "value": "site,team",
                "type": "query",
                "description": "    Default all resources are returned in the ACL.\n    If you want to filter the ACL by specific resources,\n    provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n"
              }
            ]
          },
          "docs": "Retrieve an existing User Profile ACL by ID in a given organization."
        }
      ]
    }
  ],
  "bundled": true
}