{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference agentic-search > agenticSearch systemCredentials API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "systemCredentials",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Credentials",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.coactive.ai/api/v1/auth-management/clients",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ]
          },
          "docs": "List all system-level credentials in the organization.\n\nSystem-level credentials are not tied to a specific user and never expire."
        },
        {
          "info": {
            "name": "Create Credentials",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.coactive.ai/api/v1/auth-management/clients",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create new system-level credentials. System-level credentials are not tied to a specific\nuser and never expire.\n\nThe access of the system-level credentials are scoped to the specified roles. **If no\nroles are provided, the system-level credentials will have full access to all resources**.\n\nThe client id and client secret of the created credentials can be exchanged for access tokens\nwhich can be used to make requests to the API. These credentials should only be used for\nprogrammatic access to the"
        },
        {
          "info": {
            "name": "Get Credentials",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.coactive.ai/api/v1/auth-management/clients/:client_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "client_id",
                "value": "",
                "type": "path",
                "description": "The client ID of the system-level credentials"
              }
            ]
          },
          "docs": "Get specific system-level credentials by id.\n\nThis endpoint retrieves the details of specific system-level credentials,\nincluding its roles and configuration."
        },
        {
          "info": {
            "name": "Update Credentials",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.coactive.ai/api/v1/auth-management/clients/:client_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "client_id",
                "value": "",
                "type": "path",
                "description": "The client ID of the system-level credentials"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update system-level credentials.\n\nThis endpoint allows updating the name and roles of existing system-level credentials.\n\nThe access of the system-level credentials is scoped to its roles. **If no roles are provided,\nthe system-level credentials will have full access to all resources**. If the credentials\nwas previously assigned roles and no roles are provided in the update request, the credentials\nwill gain full access to all resources."
        },
        {
          "info": {
            "name": "Delete Credentials",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.coactive.ai/api/v1/auth-management/clients/:client_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "client_id",
                "value": "",
                "type": "path",
                "description": "The client ID of the system-level credentials"
              }
            ]
          },
          "docs": "Delete system-level credentials.\n\nThis endpoint permanently deletes the system-level credentials and revokes all associated tokens.\nThis action cannot be undone."
        }
      ]
    }
  ],
  "bundled": true
}