{
  "opencollection": "1.0.0",
  "info": {
    "name": "Alteryx Server API V3 Collections Credentials API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "https://{serverHostname}/webapi/oauth2/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Credentials",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve All Credentials",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{serverHostname}/webapi/v3/credentials",
            "params": [
              {
                "name": "view",
                "value": "",
                "type": "query"
              },
              {
                "name": "userId",
                "value": "",
                "type": "query",
                "description": "Filter by user"
              },
              {
                "name": "userGroupId",
                "value": "",
                "type": "query",
                "description": "Filter by user group"
              }
            ]
          },
          "docs": "Retrieve all accessible credential records. Requires Curator role."
        },
        {
          "info": {
            "name": "Create a New Credential",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{serverHostname}/webapi/v3/credentials",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new credential record. Requires Curator role."
        },
        {
          "info": {
            "name": "Retrieve a Specific Credential",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{serverHostname}/webapi/v3/credentials/:credentialId",
            "params": [
              {
                "name": "credentialId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the credential"
              }
            ]
          },
          "docs": "Retrieve details for a specific credential record."
        },
        {
          "info": {
            "name": "Update a Credential",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{serverHostname}/webapi/v3/credentials/:credentialId",
            "params": [
              {
                "name": "credentialId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the credential"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing credential record. Requires Curator role."
        },
        {
          "info": {
            "name": "Delete a Credential",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{serverHostname}/webapi/v3/credentials/:credentialId",
            "params": [
              {
                "name": "credentialId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the credential"
              },
              {
                "name": "force",
                "value": "",
                "type": "query",
                "description": "Force deletion with share cleanup"
              }
            ]
          },
          "docs": "Delete a credential from the system. Requires Curator role."
        },
        {
          "info": {
            "name": "Share Credential With a User",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{serverHostname}/webapi/v3/credentials/:credentialId/users",
            "params": [
              {
                "name": "credentialId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the credential"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Grant a user access to a specific credential. Requires Curator role."
        },
        {
          "info": {
            "name": "Remove User Access to Credential",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{serverHostname}/webapi/v3/credentials/:credentialId/users/:userId",
            "params": [
              {
                "name": "credentialId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the credential"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the user"
              }
            ]
          },
          "docs": "Remove a user's access to a specific credential. Requires Curator role."
        },
        {
          "info": {
            "name": "Share Credential With a User Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{serverHostname}/webapi/v3/credentials/:credentialId/userGroups",
            "params": [
              {
                "name": "credentialId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the credential"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Grant a user group access to a specific credential. Requires Curator role."
        },
        {
          "info": {
            "name": "Remove User Group Access to Credential",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{serverHostname}/webapi/v3/credentials/:credentialId/userGroups/:userGroupId",
            "params": [
              {
                "name": "credentialId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the credential"
              },
              {
                "name": "userGroupId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the user group"
              }
            ]
          },
          "docs": "Remove a user group's access to a specific credential. Requires Curator role."
        }
      ]
    }
  ],
  "bundled": true
}