{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cognite 3D Asset Mapping User profiles API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "User profiles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all user profiles in the current project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/profiles",
            "params": [
              {
                "name": "identityType",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limits the number of results to be returned. The server returns no more than 1000 results even if the specified limit is larger. The default limit is 25."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor for paging through results. In general, if a response contains a `nextCursor`\nproperty, it means that there may be more results, and you should pass that value as the\n`cursor` parameter in the next request.\n\nNote that the cursor may or may not be encrypted, but either way, it is not intended to be\ndecoded. Its internal structure is not a part of the public API, and may change without\nnotice. You should treat it as an opaque string and not attempt to craft your own cursors.\n"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `userProfilesAcl:READ`\n\nDeprecated in favor of the [List principals](#tag/Principals/operation/listPrincipals) endpoint.\n\nList all user profiles in the current project. This operation supports pagination by cursor.\nThe results are ordered alphabetically by name."
        },
        {
          "info": {
            "name": "(deprecated) Get the user profile of the principal issuing the request",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/profiles/me"
          },
          "docs": "\n\n> **Required capabilities:** `userProfilesAcl:READ`\n\nDeprecated in favor of the new [endpoint](#tag/Principals/operation/getMe).\n\nRetrieves the user profile of the principal issuing the request.\nIf a principal doesn't have a user profile, you get a not found (404) response code.\nNote: User profiles are created asyncronously, so the endpoint might return 404 for\na new principal for a while (usually seconds) until the profile has been created."
        },
        {
          "info": {
            "name": "Retrieve profiles by ID in the current project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/profiles/byids",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `userProfilesAcl:READ`\n\nDeprecated in favor of the [Retrieve principals](#tag/Principals/operation/getPrincipalsById) endpoint.\n\nRetrieve one or more user profiles indexed by the user identifier in the same CDF project."
        },
        {
          "info": {
            "name": "Search user profiles in the current project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/profiles/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `userProfilesAcl:READ`\n\nDeprecated in favor of the [List principals](#tag/Principals/operation/listPrincipals) endpoint.\n\nSearch user profiles in the current project. The result set ordering and match criteria\nthreshold may change over time. This operation does not support pagination."
        },
        {
          "info": {
            "name": "Get the user profile of the principal issuing the request",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/principals/me"
          },
          "docs": "Deprecated in favor of the new [endpoint](#tag/Principals/operation/getMe).\n\nRetrieves the user profile of the principal issuing the request."
        }
      ]
    }
  ],
  "bundled": true
}