Skip to content
MCPProductDomains and accessSSO Connection

SSO Connection programs: activate, deactivate

The SSO Connection Verbs activate, deactivate as MCP do programs, with inputs, result, refusals and an example.

Reference for SSO Connection, one group of SSO Connection programs.

SSOConnection.activate

Activate turns an SSO Connection on after a test sign-in passes, so the Tenant’s people sign in through it. Verb page.

Text
do: return await $.SSOConnection.activate(input)

Emits SSOConnection.activated.

Inputs

InputTypeRequiredDescription
connectionSSO ConnectionrequiredThe SSO Connection to turn on.

Returns

OutputTypeRequiredDescription
connectionSSO ConnectionrequiredThe SSO Connection, now active.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

JSON
{
  "name": "do",
  "arguments": {
    "code": "return await $.SSOConnection.activate({ connection: 'sso_gFlPhZJ7A7' })"
  }
}

SSOConnection.deactivate

Deactivate turns an SSO Connection off, so nobody signs in through it; its configuration is kept. Verb page.

Text
do: return await $.SSOConnection.deactivate(input)

Emits SSOConnection.deactivated.

Inputs

InputTypeRequiredDescription
connectionSSO ConnectionrequiredThe SSO Connection to turn off.

Returns

OutputTypeRequiredDescription
connectionSSO ConnectionrequiredThe SSO Connection, now inactive.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

JSON
{
  "name": "do",
  "arguments": {
    "code": "return await $.SSOConnection.deactivate({ connection: 'sso_gFlPhZJ7A7' })"
  }
}