List Platforms

See how people reach Cirra from Teams and Slack, and which roles they get.

GET

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.

Query

FiltersNarrow list results with a provider-supported where expression. Learn more

string

RSQL expression used to filter list results.

PaginationRequest a specific window of rows with limit and offset. Learn more

number

Maximum number of rows to return.

number

Number of rows to skip.

SortingChoose the order of returned rows when this action supports sorting. Learn more

string

Comma-separated sort fields; prefix with - for descending.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

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.