> For the complete documentation index, see [llms.txt](https://developer.emporix.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.emporix.io/api-references-1/readme/api-reference/oauth.md). # OAuth Manage OAuth configurations (Preview) ## Listing OAuth configurations > \

\\

\ > \ > {% hint style="danger" %}\ > This functionality is in preview mode - some of the features may not be fully operational yet.\ > {% endhint %}\ > \ > Retrieves OAuth configurations based on the provided query. ```json {"openapi":"3.0.0","info":{"title":"AI Service","version":"0.0.1"},"tags":[{"name":"OAuth","description":"Manage OAuth configurations (Preview)"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["ai.agent_read"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"scopes":{"ai.text_manage":"Needed to execute actions related to the text generation.","ai.completion_manage":"Needed to execute actions related to the AI completions.","ai.agentexecution_manage":"Needed to execute agentic chat.","ai.agentexecution_manage_own":"Needed to execute agentic chat by customers.","ai.agent_read":"Needed to read AI agents.","ai.agent_manage":"Needed to manage AI agents."},"tokenUrl":"https://api.emporix.io/oauth/token"}}}},"schemas":{"OAuthResponse":{"allOf":[{"$ref":"#/components/schemas/OAuth"},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the entity."},"clientSecretToken":{"$ref":"#/components/schemas/ExpandableTokenResponse"},"metadata":{"$ref":"#/components/schemas/MetadataResponse"}}}]},"OAuth":{"type":"object","description":"OAuth 2.0 client-credentials settings for authenticating with a self-hosted LLM backend.","properties":{"url":{"type":"string","format":"uri","description":"Token endpoint URL of the OAuth 2.0 authorization server used to request an access token."},"clientId":{"type":"string","description":"OAuth 2.0 client identifier registered with the authorization server."},"grantType":{"type":"string","description":"OAuth 2.0 grant type used to obtain an access token. Currently only `client_credentials` is supported.","enum":["client_credentials"]},"scope":{"type":"string","description":"Optional space-separated list of scopes to request for the access token."},"enabled":{"type":"boolean","description":"Indicates whether the OAuth configuration is enabled."}},"required":["url","clientId","grantType"]},"ExpandableTokenResponse":{"oneOf":[{"$ref":"#/components/schemas/IdResponse"},{"$ref":"#/components/schemas/ExpandedTokenResponse"}],"description":"The full response representing token. If the `expand=token` is **not** used, then only `id` field is returned, otherwise all fields are returned."},"IdResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the resource."}}},"ExpandedTokenResponse":{"allOf":[{"$ref":"#/components/schemas/IdResponse"},{"type":"object","properties":{"name":{"type":"string","description":"Name of the token."},"metadata":{"$ref":"#/components/schemas/MetadataResponse"}}}]},"MetadataResponse":{"allOf":[{"$ref":"#/components/schemas/MetadataRequest"},{"type":"object","properties":{"createdAt":{"description":"Date and time when the object was created. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-31T13:18:02.379Z`","type":"string"},"modifiedAt":{"description":"Date and time when the object was last modified. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-31T13:18:02.379Z`","type":"string"}},"required":["version","createdAt","modifiedAt"]}]},"MetadataRequest":{"type":"object","properties":{"version":{"minimum":1,"type":"integer","description":"Version of the object. The version is required during the update operation because of the optimistic locking mechanism."}},"required":["version"]},"ErrorMessage":{"type":"object","properties":{"code":{"type":"integer"},"type":{"type":"string"},"message":{"type":"string"},"moreInfo":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"moreInfo":{"type":"string"}}}}},"description":""},"ErrorMessageFault":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}},"responses":{"400_resp_common":{"description":"The request was syntactically incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401_resp_common":{"description":"The authorization token is invalid or has expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageFault"}}}},"403_resp_common":{"description":"Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"paths":{"/ai-service/{tenant}/agentic/oauths":{"get":{"summary":"Listing OAuth configurations","operationId":"GET-ai-list-oauths","responses":{"200":{"description":"List of OAuth configurations.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OAuthResponse"}}}}},"400":{"$ref":"#/components/responses/400_resp_common"},"401":{"$ref":"#/components/responses/401_resp_common"},"403":{"$ref":"#/components/responses/403_resp_common"}},"description":"

\"\"

\n\n{% hint style=\"danger\" %}\nThis functionality is in preview mode - some of the features may not be fully operational yet.\n{% endhint %}\n\nRetrieves OAuth configurations based on the provided query.","tags":["OAuth"]}}}} ``` ## Searching OAuth configurations > \

\\

\ > \ > {% hint style="danger" %}\ > This functionality is in preview mode - some of the features may not be fully operational yet.\ > {% endhint %}\ > \ > Searches for OAuth configurations based on the provided query. ```json {"openapi":"3.0.0","info":{"title":"AI Service","version":"0.0.1"},"tags":[{"name":"OAuth","description":"Manage OAuth configurations (Preview)"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["ai.agent_read"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"scopes":{"ai.text_manage":"Needed to execute actions related to the text generation.","ai.completion_manage":"Needed to execute actions related to the AI completions.","ai.agentexecution_manage":"Needed to execute agentic chat.","ai.agentexecution_manage_own":"Needed to execute agentic chat by customers.","ai.agent_read":"Needed to read AI agents.","ai.agent_manage":"Needed to manage AI agents."},"tokenUrl":"https://api.emporix.io/oauth/token"}}}},"parameters":{"pageSize":{"schema":{"type":"string"},"in":"query","name":"pageSize","description":"The number of documents to be retrieved per page."},"pageNumber":{"schema":{"type":"string"},"in":"query","name":"pageNumber","description":"The page number to be retrieved. The size of the pages should be specified by the `pageSize` parameter."},"sort":{"schema":{"type":"string"},"in":"query","name":"sort","description":"List of properties used to sort the results, separated by colons."},"fields":{"schema":{"type":"string"},"in":"query","name":"fields","description":"Fields to be returned in the response."},"expandOAuth":{"schema":{"type":"string","enum":["token"]},"in":"query","name":"expand","description":"Fields to be expanded in the response. It means that instead of the object IDs, the whole objects are returned in the response."},"header_xTotalCount":{"schema":{"type":"boolean"},"in":"header","name":"X-Total-Count","description":"Flag indicating whether the total number of retrieved results should be returned."}},"schemas":{"OAuthResponse":{"allOf":[{"$ref":"#/components/schemas/OAuth"},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the entity."},"clientSecretToken":{"$ref":"#/components/schemas/ExpandableTokenResponse"},"metadata":{"$ref":"#/components/schemas/MetadataResponse"}}}]},"OAuth":{"type":"object","description":"OAuth 2.0 client-credentials settings for authenticating with a self-hosted LLM backend.","properties":{"url":{"type":"string","format":"uri","description":"Token endpoint URL of the OAuth 2.0 authorization server used to request an access token."},"clientId":{"type":"string","description":"OAuth 2.0 client identifier registered with the authorization server."},"grantType":{"type":"string","description":"OAuth 2.0 grant type used to obtain an access token. Currently only `client_credentials` is supported.","enum":["client_credentials"]},"scope":{"type":"string","description":"Optional space-separated list of scopes to request for the access token."},"enabled":{"type":"boolean","description":"Indicates whether the OAuth configuration is enabled."}},"required":["url","clientId","grantType"]},"ExpandableTokenResponse":{"oneOf":[{"$ref":"#/components/schemas/IdResponse"},{"$ref":"#/components/schemas/ExpandedTokenResponse"}],"description":"The full response representing token. If the `expand=token` is **not** used, then only `id` field is returned, otherwise all fields are returned."},"IdResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the resource."}}},"ExpandedTokenResponse":{"allOf":[{"$ref":"#/components/schemas/IdResponse"},{"type":"object","properties":{"name":{"type":"string","description":"Name of the token."},"metadata":{"$ref":"#/components/schemas/MetadataResponse"}}}]},"MetadataResponse":{"allOf":[{"$ref":"#/components/schemas/MetadataRequest"},{"type":"object","properties":{"createdAt":{"description":"Date and time when the object was created. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-31T13:18:02.379Z`","type":"string"},"modifiedAt":{"description":"Date and time when the object was last modified. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-31T13:18:02.379Z`","type":"string"}},"required":["version","createdAt","modifiedAt"]}]},"MetadataRequest":{"type":"object","properties":{"version":{"minimum":1,"type":"integer","description":"Version of the object. The version is required during the update operation because of the optimistic locking mechanism."}},"required":["version"]},"ErrorMessage":{"type":"object","properties":{"code":{"type":"integer"},"type":{"type":"string"},"message":{"type":"string"},"moreInfo":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"moreInfo":{"type":"string"}}}}},"description":""},"ErrorMessageFault":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}},"QParamSearchBody":{"type":"object","properties":{"q":{"type":"string","description":"A standard query parameter is used to search for specific values. \n\nSee: [Standard Practices - Query parameter](https://developer.emporix.io/api-references/standard-practices/q-param)\n"}}}},"responses":{"400_resp_common":{"description":"The request was syntactically incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401_resp_common":{"description":"The authorization token is invalid or has expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageFault"}}}},"403_resp_common":{"description":"Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"requestBodies":{"QParamSearchBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QParamSearchBody"}}}}}},"paths":{"/ai-service/{tenant}/agentic/oauths/search":{"post":{"parameters":[{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/expandOAuth"},{"$ref":"#/components/parameters/header_xTotalCount"}],"summary":"Searching OAuth configurations","operationId":"POST-ai-search-oauths","responses":{"200":{"description":"List of OAuth configurations.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OAuthResponse"}}}}},"400":{"$ref":"#/components/responses/400_resp_common"},"401":{"$ref":"#/components/responses/401_resp_common"},"403":{"$ref":"#/components/responses/403_resp_common"}},"requestBody":{"$ref":"#/components/requestBodies/QParamSearchBody"},"description":"

\"\"

\n\n{% hint style=\"danger\" %}\nThis functionality is in preview mode - some of the features may not be fully operational yet.\n{% endhint %}\n\nSearches for OAuth configurations based on the provided query.","tags":["OAuth"]}}}} ``` ## Retrieving OAuth configuration by ID > \

\\

\ > \ > {% hint style="danger" %}\ > This functionality is in preview mode - some of the features may not be fully operational yet.\ > {% endhint %}\ > \ > Retrieves the OAuth configuration by a given ID. ```json {"openapi":"3.0.0","info":{"title":"AI Service","version":"0.0.1"},"tags":[{"name":"OAuth","description":"Manage OAuth configurations (Preview)"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["ai.agent_read"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"scopes":{"ai.text_manage":"Needed to execute actions related to the text generation.","ai.completion_manage":"Needed to execute actions related to the AI completions.","ai.agentexecution_manage":"Needed to execute agentic chat.","ai.agentexecution_manage_own":"Needed to execute agentic chat by customers.","ai.agent_read":"Needed to read AI agents.","ai.agent_manage":"Needed to manage AI agents."},"tokenUrl":"https://api.emporix.io/oauth/token"}}}},"parameters":{"fields":{"schema":{"type":"string"},"in":"query","name":"fields","description":"Fields to be returned in the response."},"expandOAuth":{"schema":{"type":"string","enum":["token"]},"in":"query","name":"expand","description":"Fields to be expanded in the response. It means that instead of the object IDs, the whole objects are returned in the response."}},"schemas":{"OAuthResponse":{"allOf":[{"$ref":"#/components/schemas/OAuth"},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the entity."},"clientSecretToken":{"$ref":"#/components/schemas/ExpandableTokenResponse"},"metadata":{"$ref":"#/components/schemas/MetadataResponse"}}}]},"OAuth":{"type":"object","description":"OAuth 2.0 client-credentials settings for authenticating with a self-hosted LLM backend.","properties":{"url":{"type":"string","format":"uri","description":"Token endpoint URL of the OAuth 2.0 authorization server used to request an access token."},"clientId":{"type":"string","description":"OAuth 2.0 client identifier registered with the authorization server."},"grantType":{"type":"string","description":"OAuth 2.0 grant type used to obtain an access token. Currently only `client_credentials` is supported.","enum":["client_credentials"]},"scope":{"type":"string","description":"Optional space-separated list of scopes to request for the access token."},"enabled":{"type":"boolean","description":"Indicates whether the OAuth configuration is enabled."}},"required":["url","clientId","grantType"]},"ExpandableTokenResponse":{"oneOf":[{"$ref":"#/components/schemas/IdResponse"},{"$ref":"#/components/schemas/ExpandedTokenResponse"}],"description":"The full response representing token. If the `expand=token` is **not** used, then only `id` field is returned, otherwise all fields are returned."},"IdResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the resource."}}},"ExpandedTokenResponse":{"allOf":[{"$ref":"#/components/schemas/IdResponse"},{"type":"object","properties":{"name":{"type":"string","description":"Name of the token."},"metadata":{"$ref":"#/components/schemas/MetadataResponse"}}}]},"MetadataResponse":{"allOf":[{"$ref":"#/components/schemas/MetadataRequest"},{"type":"object","properties":{"createdAt":{"description":"Date and time when the object was created. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-31T13:18:02.379Z`","type":"string"},"modifiedAt":{"description":"Date and time when the object was last modified. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-31T13:18:02.379Z`","type":"string"}},"required":["version","createdAt","modifiedAt"]}]},"MetadataRequest":{"type":"object","properties":{"version":{"minimum":1,"type":"integer","description":"Version of the object. The version is required during the update operation because of the optimistic locking mechanism."}},"required":["version"]},"ErrorMessageFault":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}},"ErrorMessage":{"type":"object","properties":{"code":{"type":"integer"},"type":{"type":"string"},"message":{"type":"string"},"moreInfo":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"moreInfo":{"type":"string"}}}}},"description":""}},"responses":{"401_resp_common":{"description":"The authorization token is invalid or has expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageFault"}}}},"403_resp_common":{"description":"Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404_resp_common":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"paths":{"/ai-service/{tenant}/agentic/oauths/{oauthId}":{"get":{"parameters":[{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/expandOAuth"}],"summary":"Retrieving OAuth configuration by ID","operationId":"GET-ai-retrieve-oauth","responses":{"200":{"description":"A single OAuth configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthResponse"}}}},"401":{"$ref":"#/components/responses/401_resp_common"},"403":{"$ref":"#/components/responses/403_resp_common"},"404":{"$ref":"#/components/responses/404_resp_common"}},"description":"

\"\"

\n\n{% hint style=\"danger\" %}\nThis functionality is in preview mode - some of the features may not be fully operational yet.\n{% endhint %}\n\nRetrieves the OAuth configuration by a given ID.","tags":["OAuth"]}}}} ``` ## Upserting OAuth configuration > \

\\

\ > \ > {% hint style="danger" %}\ > This functionality is in preview mode - some of the features may not be fully operational yet.\ > {% endhint %}\ > \ > Updates or creates a specified OAuth configuration by replacing all of its existing data with data from the request body.\ > If the \`metadata.version\` is provided, then optimistic locking is enabled and version must match the version in the database.\ > \ > Currently only the \`client\_credentials\` grant type is supported. ```json {"openapi":"3.0.0","info":{"title":"AI Service","version":"0.0.1"},"tags":[{"name":"OAuth","description":"Manage OAuth configurations (Preview)"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["ai.agent_manage"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"scopes":{"ai.text_manage":"Needed to execute actions related to the text generation.","ai.completion_manage":"Needed to execute actions related to the AI completions.","ai.agentexecution_manage":"Needed to execute agentic chat.","ai.agentexecution_manage_own":"Needed to execute agentic chat by customers.","ai.agent_read":"Needed to read AI agents.","ai.agent_manage":"Needed to manage AI agents."},"tokenUrl":"https://api.emporix.io/oauth/token"}}}},"parameters":{"forceDisable":{"schema":{"type":"boolean"},"in":"query","name":"force","description":"Allows you to disable a given entity even if it is used as a dependency in other entries. In that case, cascade disable is performed."}},"schemas":{"IdResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the resource."}}},"ErrorMessage":{"type":"object","properties":{"code":{"type":"integer"},"type":{"type":"string"},"message":{"type":"string"},"moreInfo":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"moreInfo":{"type":"string"}}}}},"description":""},"ErrorMessageFault":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}},"OAuthRequest":{"allOf":[{"$ref":"#/components/schemas/OAuth"},{"type":"object","properties":{"clientSecretToken":{"$ref":"#/components/schemas/IdWrapperRequest"},"metadata":{"$ref":"#/components/schemas/MetadataRequest"}}}]},"OAuth":{"type":"object","description":"OAuth 2.0 client-credentials settings for authenticating with a self-hosted LLM backend.","properties":{"url":{"type":"string","format":"uri","description":"Token endpoint URL of the OAuth 2.0 authorization server used to request an access token."},"clientId":{"type":"string","description":"OAuth 2.0 client identifier registered with the authorization server."},"grantType":{"type":"string","description":"OAuth 2.0 grant type used to obtain an access token. Currently only `client_credentials` is supported.","enum":["client_credentials"]},"scope":{"type":"string","description":"Optional space-separated list of scopes to request for the access token."},"enabled":{"type":"boolean","description":"Indicates whether the OAuth configuration is enabled."}},"required":["url","clientId","grantType"]},"IdWrapperRequest":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"MetadataRequest":{"type":"object","properties":{"version":{"minimum":1,"type":"integer","description":"Version of the object. The version is required during the update operation because of the optimistic locking mechanism."}},"required":["version"]}},"responses":{"400_resp_common":{"description":"The request was syntactically incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401_resp_common":{"description":"The authorization token is invalid or has expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageFault"}}}},"403_resp_common":{"description":"Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404_resp_common":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"409_resp_common":{"description":"There are three possible reasons:\n 1. Resource with given code already exists, please choose unique code for your resource\n 2. Optimistic locking failed. If user sends metadata/version attribute which is outdated (someone else updated resource in the time user was performing his changes). User should retrieve the latest product data and retry the request.\n 3. Optimistic locking failed. User did not provide metadata/version attribute in update request, but someone else updated product while it was internally handled by product service. Resending the same request can result in successful update, but the update can override recently persisted changes.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"requestBodies":{"oauthUpsertBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthRequest"}}}}}},"paths":{"/ai-service/{tenant}/agentic/oauths/{oauthId}":{"put":{"summary":"Upserting OAuth configuration","parameters":[{"$ref":"#/components/parameters/forceDisable"}],"operationId":"PUT-ai-upsert-oauth","responses":{"201":{"description":"ID of created OAuth configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdResponse"}}}},"204":{"description":"The resource has been successfully updated."},"400":{"$ref":"#/components/responses/400_resp_common"},"401":{"$ref":"#/components/responses/401_resp_common"},"403":{"$ref":"#/components/responses/403_resp_common"},"404":{"$ref":"#/components/responses/404_resp_common"},"409":{"$ref":"#/components/responses/409_resp_common"}},"description":"

\"\"

\n\n{% hint style=\"danger\" %}\nThis functionality is in preview mode - some of the features may not be fully operational yet.\n{% endhint %}\n\nUpdates or creates a specified OAuth configuration by replacing all of its existing data with data from the request body.\nIf the `metadata.version` is provided, then optimistic locking is enabled and version must match the version in the database.\n\nCurrently only the `client_credentials` grant type is supported.","requestBody":{"$ref":"#/components/requestBodies/oauthUpsertBody"},"tags":["OAuth"]}}}} ``` ## Deleting OAuth configuration > \

\\

\ > \ > {% hint style="danger" %}\ > This functionality is in preview mode - some of the features may not be fully operational yet.\ > {% endhint %}\ > \ > Deletes OAuth configuration by given ID.\ > \ > \*\*\*Important\*\*\*: If an OAuth configuration is being used by an agent, then delete operation is not possible without \`force\` flag set to \`true\`. ```json {"openapi":"3.0.0","info":{"title":"AI Service","version":"0.0.1"},"tags":[{"name":"OAuth","description":"Manage OAuth configurations (Preview)"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["ai.agent_manage"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"scopes":{"ai.text_manage":"Needed to execute actions related to the text generation.","ai.completion_manage":"Needed to execute actions related to the AI completions.","ai.agentexecution_manage":"Needed to execute agentic chat.","ai.agentexecution_manage_own":"Needed to execute agentic chat by customers.","ai.agent_read":"Needed to read AI agents.","ai.agent_manage":"Needed to manage AI agents."},"tokenUrl":"https://api.emporix.io/oauth/token"}}}},"parameters":{"force":{"schema":{"type":"boolean"},"in":"query","name":"force","description":"Allows you to remove a given entity even if it is used as a dependency in other entries. In that case, the removed entity is unassigned from other entries."}},"responses":{"400_resp_common":{"description":"The request was syntactically incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401_resp_common":{"description":"The authorization token is invalid or has expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageFault"}}}},"403_resp_common":{"description":"Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"schemas":{"ErrorMessage":{"type":"object","properties":{"code":{"type":"integer"},"type":{"type":"string"},"message":{"type":"string"},"moreInfo":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"moreInfo":{"type":"string"}}}}},"description":""},"ErrorMessageFault":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}}},"paths":{"/ai-service/{tenant}/agentic/oauths/{oauthId}":{"delete":{"parameters":[{"$ref":"#/components/parameters/force"}],"summary":"Deleting OAuth configuration","operationId":"DELETE-ai-delete-oauth","responses":{"204":{"description":"Given OAuth configuration has been deleted."},"400":{"$ref":"#/components/responses/400_resp_common"},"401":{"$ref":"#/components/responses/401_resp_common"},"403":{"$ref":"#/components/responses/403_resp_common"}},"description":"

\"\"

\n\n{% hint style=\"danger\" %}\nThis functionality is in preview mode - some of the features may not be fully operational yet.\n{% endhint %}\n\nDeletes OAuth configuration by given ID.\n\n***Important***: If an OAuth configuration is being used by an agent, then delete operation is not possible without `force` flag set to `true`.","tags":["OAuth"]}}}} ``` ## Partially updating OAuth configuration > \

\\

\ > \ > {% hint style="danger" %}\ > This functionality is in preview mode - some of the features may not be fully operational yet.\ > {% endhint %}\ > \ > Partially updates a single OAuth configuration document with given information.\ > Single update may contain multiple partial updates in the form of an array. It contains the allowed operations list:\ > \- \`add\` (adding an item to the items list)\ > \- \`remove\` (removing an item from the items list)\ > \- \`replace\` (replacing an item with given ID with new definition) ```json {"openapi":"3.0.0","info":{"title":"AI Service","version":"0.0.1"},"tags":[{"name":"OAuth","description":"Manage OAuth configurations (Preview)"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["ai.agent_manage"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"scopes":{"ai.text_manage":"Needed to execute actions related to the text generation.","ai.completion_manage":"Needed to execute actions related to the AI completions.","ai.agentexecution_manage":"Needed to execute agentic chat.","ai.agentexecution_manage_own":"Needed to execute agentic chat by customers.","ai.agent_read":"Needed to read AI agents.","ai.agent_manage":"Needed to manage AI agents."},"tokenUrl":"https://api.emporix.io/oauth/token"}}}},"parameters":{"forceDisable":{"schema":{"type":"boolean"},"in":"query","name":"force","description":"Allows you to disable a given entity even if it is used as a dependency in other entries. In that case, cascade disable is performed."}},"responses":{"400_resp_common":{"description":"The request was syntactically incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401_resp_common":{"description":"The authorization token is invalid or has expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageFault"}}}},"403_resp_common":{"description":"Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404_resp_common":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"schemas":{"ErrorMessage":{"type":"object","properties":{"code":{"type":"integer"},"type":{"type":"string"},"message":{"type":"string"},"moreInfo":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"moreInfo":{"type":"string"}}}}},"description":""},"ErrorMessageFault":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}},"PatchRequest":{"type":"array","description":"Partial update operation list.","items":{"type":"object","properties":{"op":{"anyOf":[{"enum":["ADD","REMOVE","REPLACE"]}],"type":"string"},"path":{"type":"string"},"value":{"anyOf":[{"type":"string","description":"Value of the string type."},{"type":"object","description":"Any part of the details object."}]}},"required":["op","path"]}}},"requestBodies":{"oauthPatchBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchRequest"}}}}}},"paths":{"/ai-service/{tenant}/agentic/oauths/{oauthId}":{"patch":{"summary":"Partially updating OAuth configuration","parameters":[{"$ref":"#/components/parameters/forceDisable"}],"operationId":"PATCH-ai-update-oauth","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/400_resp_common"},"401":{"$ref":"#/components/responses/401_resp_common"},"403":{"$ref":"#/components/responses/403_resp_common"},"404":{"$ref":"#/components/responses/404_resp_common"}},"description":"

\"\"

\n\n{% hint style=\"danger\" %}\nThis functionality is in preview mode - some of the features may not be fully operational yet.\n{% endhint %}\n\nPartially updates a single OAuth configuration document with given information.\nSingle update may contain multiple partial updates in the form of an array. It contains the allowed operations list:\n - `add` (adding an item to the items list)\n - `remove` (removing an item from the items list)\n - `replace` (replacing an item with given ID with new definition)","requestBody":{"$ref":"#/components/requestBodies/oauthPatchBody"},"tags":["OAuth"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://developer.emporix.io/api-references-1/readme/api-reference/oauth.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.