Skip to main content
GET
/
settings
/
aitoolproviders
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "providerId": "<string>",
  "createdBy": "<string>",
  "isPublic": true,
  "owners": [
    {
      "id": "<string>",
      "displayName": "<string>",
      "mail": "<string>",
      "securityEnabled": true,
      "mailEnabled": true,
      "groupTypes": [
        "<string>"
      ],
      "groupType": "<string>",
      "userPrincipalName": "<string>",
      "jobTitle": "<string>",
      "department": "<string>",
      "officeLocation": "<string>"
    }
  ],
  "contributors": [
    {
      "id": "<string>",
      "displayName": "<string>",
      "mail": "<string>",
      "securityEnabled": true,
      "mailEnabled": true,
      "groupTypes": [
        "<string>"
      ],
      "groupType": "<string>",
      "userPrincipalName": "<string>",
      "jobTitle": "<string>",
      "department": "<string>",
      "officeLocation": "<string>"
    }
  ],
  "users": [
    {
      "id": "<string>",
      "displayName": "<string>",
      "mail": "<string>",
      "securityEnabled": true,
      "mailEnabled": true,
      "groupTypes": [
        "<string>"
      ],
      "groupType": "<string>",
      "userPrincipalName": "<string>",
      "jobTitle": "<string>",
      "department": "<string>",
      "officeLocation": "<string>"
    }
  ],
  "inheritEntitlements": true,
  "hideFromCatalog": true,
  "createdAt": "<string>",
  "updatedBy": "<string>",
  "updatedAt": "<string>",
  "name": "<string>",
  "description": "<string>",
  "isEnabled": true,
  "apiKey": "<string>",
  "category": "<string>",
  "tags": [
    "<string>"
  ],
  "version": "<string>",
  "toolName": "<string>",
  "parameters": {},
  "endpoint": "<string>",
  "functionCode": "<string>",
  "graphqlEndpoint": "<string>",
  "graphqlQuery": "<string>",
  "requiredDelegatedScope": "<string>"
}

Authorizations

​
Authorization
string
header
required

Azure AD access token obtained via MSAL

Path Parameters

​
id
string
required

Response

200 - application/json

Tool provider object

Custom tool provider registration

​
id
string
required
​
providerId
string
required

Provider identifier (e.g. 'tavily', 'serp', 'sql')

​
scope
enum<string>

Access control model

Available options:
personal,
shared
​
createdBy
string

UPN of the creator

​
isPublic
boolean

Allow public read access

​
owners
object[]
​
contributors
object[]
​
users
object[]
​
inheritEntitlements
​
hideFromCatalog
boolean

Hide entity from user-facing recommendations and catalog/search surfaces (still accessible to owners/contributors/admins)

​
createdAt
string

ISO-8601 creation timestamp

​
updatedBy
string
​
updatedAt
string

ISO-8601 update timestamp

​
name
string
​
description
string
​
isEnabled
boolean
​
authType
enum<string>
Available options:
managedSystemIdentity,
apiKey,
connectionString
​
apiKey
string

Redacted in responses

​
category
string

e.g. 'search', 'database', 'api'

​
tags
string[]
​
version
string
​
toolName
string
​
parameters
object
​
integrationType
enum<string>
Available options:
registry,
rest_api,
graphql,
function
​
endpoint
string

REST API endpoint for rest_api type

​
method
enum<string>
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
​
functionCode
string

JS code for function type

​
graphqlEndpoint
string
​
graphqlQuery
string
​
requiredDelegatedScope
string