Mentimeter
App · 11 actions
Administer Mentimeter workspace users and groups through its Enterprise SCIM API.
Actions
| Action | What it does |
|---|---|
| Create group | Create a new SCIM group. |
| Create user | Create a new user. |
| Delete group | Delete a group. |
| Delete user | Delete a single user. |
| Get group | Get a group. |
| Get service provider config | Get service provider configuration. |
| Get user | Get a single user. |
| List groups | Get a paged list of groups. |
| List users | Get all users. |
| Update group | Update the attributes of a group using a sequence of operations. |
| Update user | Update a single user. |
Create group
Create a new SCIM group.
Inputs
- Display name
display_nametextRequired - The name of the Group.
- External ID
external_idtext - The identifier for the Group as defined by the provisioning client.
- Members
memberslist - 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 ID
external_idtext - External id.
- User name
user_nametextRequired - The user's email connected to the mentimeter account
- Active
activetrue/false - The user's status
- Display name
display_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
- Id
idtextRequired - The ID of the group
Outputs
dataobject- Returned value.
Example output
{
"data": {}
}Delete user
Delete a single user.
Inputs
- Id
idtextRequired - The user ID
Outputs
dataobject- Returned value.
Example output
{
"data": {}
}Get group
Get a group.
Inputs
- Id
idtextRequired - The ID of the group.
- Attributes
attributestext - A comma-separated list of resource attribute names in standard attribute notation.
- Exclude attributes
exclude_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
- Id
idtextRequired - 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
- Attributes
attributestext - A comma-separated list of resource attribute names in standard attribute notation.
- Exclude attributes
exclude_attributestext - A comma-separated list of resource attribute names in standard attribute notation to exclude.
- Filter
filtertext - A comma-separated list of resource filters in standard attribute notation.
- Sort by
sort_bytext - A comma-separated list of resource attribute names in standard attribute notation to sort by.
- Sort order
sort_ordertext - The sort order of the results.
- Start index
start_indexnumber - The 1-based index of the first query result.
- Count
countnumber - 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
- Attributes
attributestext - A comma-separated list of attribute names to include in the response.
- Filter
filtertext - 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
- Id
idtextRequired - Id.
- Display name
display_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
- Operations
operationslist - 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"
}
}