{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Organization Members API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
      "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Organization Members",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Members",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/members",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              }
            ]
          },
          "docs": "Lists the members of an [organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update Organization Members",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/members",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "sendEmailToInvitedUsers",
                "value": "",
                "type": "query",
                "description": "Whether to send an invitation email alongside the invite(s).</br>**Default:** `true`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the [members](https://docs.coveo.com/en/2869/) of an [organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Show Member",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/members/:username",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The username of the member to show.</br>**Example:** `jsmith@email.com-google`"
              }
            ]
          },
          "docs": "Shows a [member](https://docs.coveo.com/en/2869/) of an [organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update Member",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/members/:username",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The username of the member to update.</br>**Example:** `jsmith@email.com-google`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a member of an [organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Delete Member",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/members/:username",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The username of the member to delete.</br>**Example:** `jsmith@email.com-google`"
              }
            ]
          },
          "docs": "Deletes a member from all groups of an [organization](https://docs.coveo.com/en/185/).</br>**Note:** Deleted users can still be included by domain.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "List Groups for Organization Member",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/members/:username/groups",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The username of the user for which to list groups.</br>**Example:** `jsmith@email.com-google`"
              }
            ]
          },
          "docs": "Lists the groups to which an organization member belongs.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "List Privileges of Current User",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/members/privileges",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              }
            ]
          },
          "docs": "Lists the privileges for the current user on an [organization](https://docs.coveo.com/en/185/)."
        }
      ]
    }
  ],
  "bundled": true
}