Mentimeter

App · 11 actions

Administer Mentimeter workspace users and groups through its Enterprise SCIM API.

Actions

ActionWhat it does
Create groupCreate a new SCIM group.
Create userCreate a new user.
Delete groupDelete a group.
Delete userDelete a single user.
Get groupGet a group.
Get service provider configGet service provider configuration.
Get userGet a single user.
List groupsGet a paged list of groups.
List usersGet all users.
Update groupUpdate the attributes of a group using a sequence of operations.
Update userUpdate a single user.

Create group

Create a new SCIM group.

Inputs

Display namedisplay_nametextRequired
The name of the Group.
External IDexternal_idtext
The identifier for the Group as defined by the provisioning client.
Membersmemberslist
A multi-valued list of members of the Group.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "displayName": "example",
    "externalId": "example",
    "id": "example",
    "members": [],
    "meta": {
      "created": "example",
      "lastModified": "example",
      "location": "example"
    },
    "schemas": []
  }
}

Create user

Create a new user.

Inputs

External IDexternal_idtext
External id.
User nameuser_nametextRequired
The user's email connected to the mentimeter account
Activeactivetrue/false
The user's status
Display namedisplay_nametext
The name of the user, suitable for display to end-users.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "active": false,
    "displayName": "example",
    "externalId": "example",
    "id": "example",
    "meta": {
      "created": "example",
      "lastModified": "example",
      "resourceType": "example"
    },
    "schemas": [],
    "urn:scim:mentimeter:custom:schema:1.0": {
      "lastActive": "example"
    },
    "userName": "example",
    "userType": "owner"
  }
}

Delete group

Delete a group.

Inputs

IdidtextRequired
The ID of the group

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Delete user

Delete a single user.

Inputs

IdidtextRequired
The user ID

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Get group

Get a group.

Inputs

IdidtextRequired
The ID of the group.
Attributesattributestext
A comma-separated list of resource attribute names in standard attribute notation.
Exclude attributesexclude_attributestext
A comma-separated list of resource attribute names in standard attribute notation to exclude.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "displayName": "example",
    "externalId": "example",
    "id": "example",
    "members": [],
    "meta": {
      "created": "example",
      "lastModified": "example",
      "location": "example"
    },
    "schemas": []
  }
}

Get service provider config

Get service provider configuration.

Inputs

None.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "authenticationSchemas": [],
    "bulk": {
      "supported": false
    },
    "changePassword": {
      "supported": false
    },
    "documentationUri": "example",
    "etag": {
      "supported": false
    },
    "filter": {
      "supported": false
    },
    "get": {
      "supported": false
    },
    "patch": {
      "supported": false
    },
    "post": {
      "supported": false
    },
    "put": {
      "supported": false
    },
    "schemas": [],
    "sort": {
      "supported": false
    }
  }
}

Get user

Get a single user.

Inputs

IdidtextRequired
The user ID

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "active": false,
    "displayName": "example",
    "externalId": "example",
    "id": "example",
    "meta": {
      "created": "example",
      "lastModified": "example",
      "resourceType": "example"
    },
    "schemas": [],
    "urn:scim:mentimeter:custom:schema:1.0": {
      "lastActive": "example"
    },
    "userName": "example",
    "userType": "owner"
  }
}

List groups

Get a paged list of groups.

Inputs

Attributesattributestext
A comma-separated list of resource attribute names in standard attribute notation.
Exclude attributesexclude_attributestext
A comma-separated list of resource attribute names in standard attribute notation to exclude.
Filterfiltertext
A comma-separated list of resource filters in standard attribute notation.
Sort bysort_bytext
A comma-separated list of resource attribute names in standard attribute notation to sort by.
Sort ordersort_ordertext
The sort order of the results.
Start indexstart_indexnumber
The 1-based index of the first query result.
Countcountnumber
The number of query results per page.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "Resources": [],
    "itemsPerPage": 1,
    "schemas": [],
    "startIndex": 1,
    "totalResults": 1
  }
}

List users

Get all users.

Inputs

Attributesattributestext
A comma-separated list of attribute names to include in the response.
Filterfiltertext
A single SCIM filter expression. Compound filters using `and`, `or`, or `not` are not supported. See the SCIM section of the introduction for supported attributes and operators.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "Resources": [],
    "itemsPerPage": 1,
    "schemas": [],
    "startIndex": 1,
    "totalResults": 1
  }
}

Update group

Update the attributes of a group using a sequence of operations.

Inputs

IdidtextRequired
Id.
Display namedisplay_nametextRequired
Display name.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "displayName": "example",
    "externalId": "example",
    "id": "example",
    "members": [],
    "meta": {
      "created": "example",
      "lastModified": "example",
      "location": "example"
    },
    "schemas": []
  }
}

Update user

Update a single user.

Inputs

Operationsoperationslist
Operations.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "active": false,
    "displayName": "example",
    "externalId": "example",
    "id": "example",
    "meta": {
      "created": "example",
      "lastModified": "example",
      "resourceType": "example"
    },
    "schemas": [],
    "urn:scim:mentimeter:custom:schema:1.0": {
      "lastActive": "example"
    },
    "userName": "example",
    "userType": "owner"
  }
}

On this page