--- updatedAt: 2026-05-11T14:55:41.000Z agentTools: projectIndex: https://api.authaction.com/llms.txt --- # Disable connection for specific client # OpenAPI definition ```json { "openapi": "3.0.0", "paths": { "/api/v1/connections/{connectionId}/disable/{clientId}": { "patch": { "operationId": "ConnectionsController_disableclient", "summary": "Disable connection for specific client", "parameters": [ { "name": "connectionId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "clientId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 200 }, "message": { "type": "string", "example": "success" }, "data": { "$ref": "#/components/schemas/ConnectionObject" } } } } } }, "400": { "description": "Invalid connection id" }, "401": { "description": "Unauthorized" }, "403": { "description": "User not member of tenant" } }, "tags": [ "Connections" ], "security": [ { "bearer": [] } ] } } }, "info": { "title": "AuthAction", "description": "authentication and authorization", "version": "1.0", "contact": {} }, "tags": [ { "name": "Connections", "description": "Manage Connections between services" } ], "servers": [ { "url": "https://{tenant}.{region}.authaction.com", "description": "Dynamic server based on tenant", "variables": { "tenant": { "default": "your-tenant-name", "description": "The tenant identifier" }, "region": { "default": "eu", "description": "The tenant region (au|ca|cn|eu|in|jp|us)" } } } ], "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http", "description": "Obtain a Bearer token by passing M2M client app credential through the /oauth2/m2m/token endpoint" } }, "schemas": { "PasswordConnectionOptionsObject": { "type": "object", "properties": { "disableSignup": { "type": "boolean", "example": false }, "passkeyEnabled": { "type": "boolean", "example": false }, "verifyEmailByCode": { "type": "boolean", "example": false } }, "required": [ "disableSignup", "passkeyEnabled" ] }, "GoogleConnectionOptionsObject": { "type": "object", "properties": { "clientId": { "type": "string", "example": "google-client-id" }, "clientSecret": { "type": "string", "example": "google-client-secret" } }, "required": [ "clientId", "clientSecret" ] }, "GithubConnectionOptionsObject": { "type": "object", "properties": { "clientId": { "type": "string", "example": "github-client-id" }, "clientSecret": { "type": "string", "example": "github-client-secret" } }, "required": [ "clientId", "clientSecret" ] }, "MicrosoftConnectionOptionsObject": { "type": "object", "properties": { "clientId": { "type": "string", "example": "microft-client-id" }, "clientSecret": { "type": "string", "example": "microsoft-client-secret" } }, "required": [ "clientId", "clientSecret" ] }, "LinkedinConnectionOptionsObject": { "type": "object", "properties": { "clientId": { "type": "string", "example": "linkedin-client-id" }, "clientSecret": { "type": "string", "example": "linkedin-client-secret" } }, "required": [ "clientId", "clientSecret" ] }, "TwitterConnectionOptionsObject": { "type": "object", "properties": { "clientId": { "type": "string", "example": "twitter-client-id" }, "clientSecret": { "type": "string", "example": "twitter-client-secret" } }, "required": [ "clientId", "clientSecret" ] }, "FacebookConnectionOptionsObject": { "type": "object", "properties": { "clientId": { "type": "string", "example": "facebook-client-id" }, "clientSecret": { "type": "string", "example": "facebook-client-secret" } }, "required": [ "clientId", "clientSecret" ] }, "GitlabConnectionOptionsObject": { "type": "object", "properties": { "clientId": { "type": "string", "example": "gitlab-client-id" }, "clientSecret": { "type": "string", "example": "gitlab-client-secret" } }, "required": [ "clientId", "clientSecret" ] }, "SlackConnectionOptionsObject": { "type": "object", "properties": { "clientId": { "type": "string", "example": "slack-client-id" }, "clientSecret": { "type": "string", "example": "slack-client-secret" } }, "required": [ "clientId", "clientSecret" ] }, "AmazonConnectionOptionsObject": { "type": "object", "properties": { "clientId": { "type": "string", "example": "amazon-client-id" }, "clientSecret": { "type": "string", "example": "amazon-client-secret" } }, "required": [ "clientId", "clientSecret" ] }, "BitbucketConnectionOptionsObject": { "type": "object", "properties": { "clientId": { "type": "string", "example": "bitbucket-client-id" }, "clientSecret": { "type": "string", "example": "bitbucket-client-secret" } }, "required": [ "clientId", "clientSecret" ] }, "DiscordConnectionOptionsObject": { "type": "object", "properties": { "clientId": { "type": "string", "example": "bitbucket-client-id" }, "clientSecret": { "type": "string", "example": "bitbucket-client-secret" } }, "required": [ "clientId", "clientSecret" ] }, "SAMLConnectionOptionsObject": { "type": "object", "properties": { "entryPoint": { "type": "string", "example": "https://idp.example.com/sso" }, "issuer": { "type": "string", "example": "https://tenant.eu.authaction.com" }, "cert": { "type": "string", "example": "-----BEGIN CERTIFICATE-----..." } }, "required": [ "entryPoint", "issuer" ] }, "OktaWorkforceConnectionOptionsObject": { "type": "object", "properties": { "entryPoint": { "type": "string", "example": "https://idp.example.com/sso" }, "issuer": { "type": "string", "example": "https://tenant.eu.authaction.com" }, "cert": { "type": "string", "example": "-----BEGIN CERTIFICATE-----..." } }, "required": [ "entryPoint", "issuer" ] }, "GoogleWorkspaceConnectionOptionsObject": { "type": "object", "properties": { "entryPoint": { "type": "string", "example": "https://idp.example.com/sso" }, "issuer": { "type": "string", "example": "https://tenant.eu.authaction.com" }, "cert": { "type": "string", "example": "-----BEGIN CERTIFICATE-----..." } }, "required": [ "entryPoint", "issuer" ] }, "AzureADConnectionOptionsObject": { "type": "object", "properties": { "entryPoint": { "type": "string", "example": "https://idp.example.com/sso" }, "issuer": { "type": "string", "example": "https://tenant.eu.authaction.com" }, "cert": { "type": "string", "example": "-----BEGIN CERTIFICATE-----..." } }, "required": [ "entryPoint", "issuer" ] }, "ADFSConnectionOptionsObject": { "type": "object", "properties": { "entryPoint": { "type": "string", "example": "https://idp.example.com/sso" }, "issuer": { "type": "string", "example": "https://tenant.eu.authaction.com" }, "cert": { "type": "string", "example": "-----BEGIN CERTIFICATE-----..." } }, "required": [ "entryPoint", "issuer" ] }, "ADLDAPConnectionOptionsObject": { "type": "object", "properties": { "serverUrl": { "type": "string", "example": "ldaps://ad.example.com:636" }, "baseDN": { "type": "string", "example": "dc=example,dc=com" }, "bindDN": { "type": "string", "example": "cn=admin,dc=example,dc=com" }, "searchFilter": { "type": "string", "example": "(sAMAccountName={{username}})" } }, "required": [ "serverUrl", "baseDN", "bindDN" ] }, "PingFederateConnectionOptionsObject": { "type": "object", "properties": { "entryPoint": { "type": "string", "example": "https://idp.example.com/sso" }, "issuer": { "type": "string", "example": "https://tenant.eu.authaction.com" }, "cert": { "type": "string", "example": "-----BEGIN CERTIFICATE-----..." } }, "required": [ "entryPoint", "issuer" ] }, "JumpCloudConnectionOptionsObject": { "type": "object", "properties": { "entryPoint": { "type": "string", "example": "https://idp.example.com/sso" }, "issuer": { "type": "string", "example": "https://tenant.eu.authaction.com" }, "cert": { "type": "string", "example": "-----BEGIN CERTIFICATE-----..." } }, "required": [ "entryPoint", "issuer" ] }, "ConnectionObject": { "type": "object", "properties": { "id": { "type": "string", "example": "662baf9b1ae06c2c71676e46" }, "name": { "type": "string", "example": "Myconnection" }, "type": { "type": "object", "example": "email-password" }, "displayName": { "type": "string", "example": "Google" }, "tenant": { "type": "string", "example": "662baf9b1ae06c2c71676e44" }, "clients": { "example": [ "client1", "client2" ], "type": "array", "items": { "type": "string" } }, "options": { "oneOf": [ { "$ref": "#/components/schemas/PasswordConnectionOptionsObject" }, { "$ref": "#/components/schemas/GoogleConnectionOptionsObject" }, { "$ref": "#/components/schemas/GithubConnectionOptionsObject" }, { "$ref": "#/components/schemas/MicrosoftConnectionOptionsObject" }, { "$ref": "#/components/schemas/LinkedinConnectionOptionsObject" }, { "$ref": "#/components/schemas/TwitterConnectionOptionsObject" }, { "$ref": "#/components/schemas/FacebookConnectionOptionsObject" }, { "$ref": "#/components/schemas/GitlabConnectionOptionsObject" }, { "$ref": "#/components/schemas/SlackConnectionOptionsObject" }, { "$ref": "#/components/schemas/AmazonConnectionOptionsObject" }, { "$ref": "#/components/schemas/BitbucketConnectionOptionsObject" }, { "$ref": "#/components/schemas/DiscordConnectionOptionsObject" }, { "$ref": "#/components/schemas/SAMLConnectionOptionsObject" }, { "$ref": "#/components/schemas/OktaWorkforceConnectionOptionsObject" }, { "$ref": "#/components/schemas/GoogleWorkspaceConnectionOptionsObject" }, { "$ref": "#/components/schemas/AzureADConnectionOptionsObject" }, { "$ref": "#/components/schemas/ADFSConnectionOptionsObject" }, { "$ref": "#/components/schemas/ADLDAPConnectionOptionsObject" }, { "$ref": "#/components/schemas/PingFederateConnectionOptionsObject" }, { "$ref": "#/components/schemas/JumpCloudConnectionOptionsObject" } ] }, "createdAt": { "type": "string", "example": "2025-01-22T10:00:00.000Z", "description": "Creation timestamp" }, "updatedAt": { "type": "string", "example": "2025-01-23T15:00:00.000Z", "description": "Last updated timestamp" } }, "required": [ "id", "name", "type", "displayName", "tenant", "clients", "options", "createdAt", "updatedAt" ] } } } } ```