Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 3.35 KB

permissions-api.md

File metadata and controls

65 lines (41 loc) · 3.35 KB
Raw
title url category description weight deprecated
Permissions API
/apidocs-mxsdk/apidocs/permissions-api/
API Documentation
With this API, you can retrieve the user roles of your app users so that you can grant them specific access levels.
85
true

1 Introduction

{{% alert color="warning" %}} The AppCloudServices module has now been removed from the Mendix Marketplace and this API is therefore deprecated. {{% /alert %}}

The Permissions API enables retrieving the user roles a specific user has in your application. There are several ways in which the roles granted to a user in an application can be changed:

  • A user may be granted roles through a group policy for a group in which they are a member. Group policies define a specific set of user roles to be granted to members of the group to which the policy applies for a specific environment. Group membership can also be changed by the User Management API .

{{% alert color="info" %}}

The Permissions API will require the EnvironmentUUID and EnvironmentPassword parameters to authenticate and authorize requests; the values for these should come from constants from the AppCloudServices module with the same name. The Mendix Developer Portal will automatically set these constants; you do not need to set these yourself. For this reason, the Permissions API will however only function for applications which use the AppCloudServices module and are deployed through the Mendix Developer Portal.

{{% /alert %}}

The service is part of the AppCloudServices module, and it's included in the default themes when creating a new application. Both of these options include a default implementation of the Permissions API.

2 API Calls

2.1 GetRolesForOpenID

2.1.1 Description

Retrieves the user roles for a specific user, based on their OpenID; this will return a list of AppRole objects representing the user roles the user has.

{{% alert color="info" %}}

Note that a request will return a list of non-persistable objects. It's up to the implementer of the Permissions API to use these to create a database representation of the roles the user has in the application.

{{% /alert %}}

2.1.2 Available In

API Version 1.

2.1.3 Parameters

Name Parameter type Required Description
OpenID String Yes OpenID of the user for which you are retrieving the roles.
EnvironmentUUID String Yes UUID of the requesting environment. This should be the value of the AppCloudServices.EnvironmentUUID constant, which the Mendix Developer Portal will fill in automatically.
EnvironmentPassword String Yes Password of the requesting environment. This should be the value of the AppCloudServices.EnvironmentUUID constant, which the Mendix Developer Portal will fill in automatically.

2.1.4 Return type

List of PermissionsAPI.AppRole objects.

{{< figure src="/attachments/apidocs-mxsdk/apidocs/permissions-api/18582265.png" class="no-border" >}}

2.1.4.1 AppRole
Attribute Type Description
UUID String UUID of the user role. Using, this the corresponding System.UserRole object can be retrieved as this UUID will match the UserRole's ModelGUID attribute.
DisplayName String Name of the user role