Sign inGet started
Docs
Get started

Update Platform

Set the email domains, guest access, automatic accounts, and group-to-role mappings for Teams or Slack sign-in.

PUT

Path

Path parameters
stringrequired

The platform: microsoft (Teams) or slack.

Headers

Optional headers
string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Body

Arguments
array of string

The full list of email domains that may sign in.

boolean

True to create MindCloud accounts for new people from those domains.

string

The default role for new people, from List Roles.

boolean

True to let tenant or workspace guests sign in.

array of object

The full list of group-to-role mappings.

  • groupIdstringrequired

    The directory group id.

  • roleIdstringrequired

    The role it grants (List Roles).

string

The role for people in no mapped group, or null to refuse them.

Response fields

idstring

The platform: microsoft (Teams) or slack.

  • microsoft
  • slack
isConnectedboolean

True once a workspace or tenant was connected in Cirra. Connecting proves ownership of it, so it is done in Cirra, not through the API.

directoryIdstring

The connected Slack workspace or Microsoft tenant id.

directoryNamestring

Its name.

allowedEmailDomainsarray of string

Email domains whose people may sign in through the platform. Consumer domains such as gmail.com are refused.

autoCreateUsersboolean

True when people from those domains who have no MindCloud account get one when they first sign in.

defaultRoleIdstring

The role new people get when no group mapping applies and no unmapped role is set (List Roles).

allowGuestsboolean

True when guests of the tenant or workspace may sign in.

roleMappingsarray of objects

Which directory group grants which role. The first group a person is in decides.

  • groupIdstring

    The directory group id.

  • roleIdstring

    The role it grants (List Roles).

unmappedRoleIdstring

The role for someone in none of the mapped groups. Null: they are refused.