org.mule.modules

mule-module-stormpath

config

Namespace	http://www.mulesoft.org/schema/mule/stormpath
Schema Location	http://www.mulesoft.org/schema/mule/stormpath/current/mule-stormpath.xsd (View Schema)
Schema Version	3.4
Minimum Mule Version	3.4.0

Module Overview

Stormpath Connector.

Summary

Configuration
<stormpath:config> Configure an instance of this module

Message Processors
<stormpath:attempt-login> Attempt a login with the provided credentials.
<stormpath:create-account> Create an account.
<stormpath:create-account-store-mapping> Create an account store mapping.
<stormpath:create-application> Create an application.
<stormpath:create-directory> Create a directory.
<stormpath:create-group> Create a group in a directory.
<stormpath:create-group-membership> Add an account to a group.
<stormpath:create-password-reset-token> Create a new password reset token for the provided email.
<stormpath:delete-account> Delete an account.
<stormpath:delete-account-store-mapping> Delete an account store mapping.
<stormpath:delete-application> Delete an application.
<stormpath:delete-directory> Delete a directory.
<stormpath:delete-group> Delete a group.
<stormpath:delete-group-membership> Remove an account from a group.
<stormpath:read-account> Read an account.
<stormpath:read-account-groups> Read a paginated list of groups that belong to an account.
<stormpath:read-account-store-mapping> Read an account store mapping.
<stormpath:read-account-store-mappings> Read the account store mappings for an application.
<stormpath:read-application> Read an application.
<stormpath:read-application-accounts> Read a paginated list of accounts that belong to an application.
<stormpath:read-directory> Read a directory.
<stormpath:read-directory-accounts> Read a paginated list of accounts that belong to a directory.
<stormpath:read-directory-groups> Read a paginated list of groups that belong to a directory.
<stormpath:read-group> Read a group.
<stormpath:read-group-accounts> Read a paginated list of accounts that belong to a group.
<stormpath:read-password-reset-token> Read an existing password reset token.
<stormpath:read-tenant> Read a tenant.
<stormpath:read-tenant-applications> Read a paginated list of applications that belong to a tenant.
<stormpath:read-tenant-directories> Read a paginated list of directories that belong to a tenant.
<stormpath:update-account> Update an account.
<stormpath:update-account-store-mapping> Update an account store mapping.
<stormpath:update-application> Update an application.
<stormpath:update-directory> Update a directory.
<stormpath:update-group> Update a group.
<stormpath:update-tenant> Update a tenant.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:stormpath="http://www.mulesoft.org/schema/mule/stormpath"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/stormpath
               http://www.mulesoft.org/schema/mule/stormpath/current/mule-stormpath.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description	Java Type	MIME Type	Encoding
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
xs:string	apiKeyId		Optional. The API key ID used to authenticate to Stormpath.
xs:string	apiKeySecret		Optional. The API key secret used to authenticate to Stormpath.

Example

INCLUDE_ERROR

Message Processors

<stormpath:attempt-login>

Attempt a login with the provided credentials.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
applicationId	The unique identifier of the application.	String	/	UTF-8
loginAttempt	A `LoginAttempt` instance.	LoginAttempt	/

Returns

Return Type	Description
LoginSuccess	a `LoginSuccess` in case the login attempt was a success.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:create-account>

Create an account.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
directoryId	The unique identifier of the directory.	String	/	UTF-8
account	The `Account` to create.	Account	/

Returns

Return Type	Description
Account	the newly created `Account`.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:create-account-store-mapping>

Create an account store mapping.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accountStoreMapping		An `AccountStoreMapping` to create.	AccountStoreMapping	/

Returns

Return Type	Description
AccountStoreMapping	the created `AccountStoreMapping` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:create-application>

Create an application.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type
config-ref		Optional. Specify which configuration to use.
application		The `Application` to create.	Application	/
createDirectory	false	Optional. Define if a directory should be created and associated with the new application.	boolean	/

Returns

Return Type	Description
Application	the created `Application` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:create-directory>

Create a directory.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
directory		The `Directory` to create.	Directory	/

Returns

Return Type	Description
Directory	a newly created `Directory` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:create-group>

Create a group in a directory.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
directoryId	The unique identifier of the directory.	String	/	UTF-8
group	The `Group` to create.	Group	/

Returns

Return Type	Description
Group	a newly created `Group` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:create-group-membership>

Add an account to a group.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
groupMembership		A `GroupMembership` instance that specifies the account and group to link.	GroupMembership	/

Returns

Return Type	Description
GroupMembership	a newly created `GroupMembership`.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:create-password-reset-token>

Create a new password reset token for the provided email.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
applicationId	The unique identifier of the application.	String	/	UTF-8
email	An `Email` instance.	Email	/

Returns

Return Type	Description
PasswordResetToken	a newly created `PasswordResetToken` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:delete-account>

Delete an account.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accountId		The unique identifier of the account.	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:delete-account-store-mapping>

Delete an account store mapping.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accountStoreMappingId		The unique identifier of the account store mapping.	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:delete-application>

Delete an application.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
applicationId		The unique identifier of the application.	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:delete-directory>

Delete a directory.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
directoryId		The unique identifier of the directory.	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:delete-group>

Delete a group.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
groupId		The unique identifier of the group.	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:delete-group-membership>

Remove an account from a group.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
groupMembershipId		The unique identifier of the group membership.	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:read-account>

Read an account.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accountId		The unique identifier of the account.	String	/	UTF-8

Returns

Return Type	Description
Account	an `Account` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:read-account-groups>

Read a paginated list of groups that belong to an account.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accountId		The unique identifier of the account.	String	/	UTF-8
offset	0	Optional. The zero-based starting index in the entire collection of the first item to return.	Integer	/
limit	25	Optional. The maximum number of collection items to return for a single request.	Integer	/

Returns

Return Type	Description
Groups	a `Groups` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:read-account-store-mapping>

Read an account store mapping.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accountStoreMappingId		The unique identifier of the account store mapping.	String	/	UTF-8

Returns

Return Type	Description
AccountStoreMapping	an `AccountStoreMapping` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:read-account-store-mappings>

Read the account store mappings for an application.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
applicationId		The unique identifier of the application.	String	/	UTF-8

Returns

Return Type	Description
AccountStoreMappings	a `AccountStoreMappings` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:read-application>

Read an application.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
applicationId		The unique identifier of the application.	String	/	UTF-8

Returns

Return Type	Description
Application	an `Application` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:read-application-accounts>

Read a paginated list of accounts that belong to an application.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
applicationId		The unique identifier of the application.	String	/	UTF-8
offset	0	Optional. The zero-based starting index in the entire collection of the first item to return.	Integer	/
limit	25	Optional. The maximum number of collection items to return for a single request.	Integer	/

Returns

Return Type	Description
Accounts	an `Accounts` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:read-directory>

Read a directory.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
directoryId		The unique identifier of the directory.	String	/	UTF-8

Returns

Return Type	Description
Directory	a `Directory` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:read-directory-accounts>

Read a paginated list of accounts that belong to a directory.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
directoryId		The unique identifier of the directory.	String	/	UTF-8
offset	0	Optional. The zero-based starting index in the entire collection of the first item to return.	Integer	/
limit	25	Optional. The maximum number of collection items to return for a single request.	Integer	/

Returns

Return Type	Description
Accounts	an `Accounts` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:read-directory-groups>

Read a paginated list of groups that belong to a directory.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
directoryId		The unique identifier of the directory.	String	/	UTF-8
offset	0	Optional. The zero-based starting index in the entire collection of the first item to return.	Integer	/
limit	25	Optional. The maximum number of collection items to return for a single request.	Integer	/

Returns

Return Type	Description
Groups	a `Groups` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:read-group>

Read a group.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
groupId		The unique identifier of the group.	String	/	UTF-8

Returns

Return Type	Description
Group	a `Group` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:read-group-accounts>

Read a paginated list of accounts that belong to a group.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
groupId		The unique identifier of the group.	String	/	UTF-8
offset	0	Optional. The zero-based starting index in the entire collection of the first item to return.	Integer	/
limit	25	Optional. The maximum number of collection items to return for a single request.	Integer	/

Returns

Return Type	Description
Accounts	an `Accounts` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:read-password-reset-token>

Read an existing password reset token.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
applicationId	The unique identifier of the application.	String	/	UTF-8
passwordResetTokenId	The unique identifier of the password reset token.	String	/	UTF-8

Returns

Return Type	Description
PasswordResetToken	a `PasswordResetToken` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:read-tenant>

Read a tenant.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
tenantId		The unique identifier of the tenant or `current` for the currently authenticated tenant.	String	/	UTF-8

Returns

Return Type	Description
Tenant	a `Tenant` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:read-tenant-applications>

Read a paginated list of applications that belong to a tenant.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
tenantId		The unique identifier of the tenant (`current` is not a valid value).	String	/	UTF-8
offset	0	Optional. The zero-based starting index in the entire collection of the first item to return.	Integer	/
limit	25	Optional. The maximum number of collection items to return for a single request.	Integer	/

Returns

Return Type	Description
Applications	an `Applications` instance.

Exception Payloads

Payload Class	Description
IOException	IOException if anything goes wrong with the operation.

<stormpath:read-tenant-directories>

Read a paginated list of directories that belong to a tenant.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
tenantId		The unique identifier of the tenant (`current` is not a valid value).	String	/	UTF-8
offset	0	Optional. The zero-based starting index in the entire collection of the first item to return.	Integer	/
limit	25	Optional. The maximum number of collection items to return for a single request.	Integer	/

Returns

Return Type	Description
Directories	a `Directories` instance.

Exception Payloads

Payload Class	Description
IOException	IOException if anything goes wrong with the operation.

<stormpath:update-account>

Update an account.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
accountId	The unique identifier of the account.	String	/	UTF-8
account	The `Account` to update.	Account	/

Returns

Return Type	Description
Account	the updated `Account`.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:update-account-store-mapping>

Update an account store mapping.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
accountStoreMappingId	The unique identifier of the account store mapping.	String	/	UTF-8
accountStoreMapping	An `AccountStoreMapping` instance that contains the fields to update.	AccountStoreMapping	/

Returns

Return Type	Description
AccountStoreMapping	the updated `AccountStoreMapping` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:update-application>

Update an application.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
applicationId	The unique identifier of the application.	String	/	UTF-8
application	The `Application` to update.	Application	/

Returns

Return Type	Description
Application	the updated `Application` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:update-directory>

Update a directory.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
directoryId	The unique identifier of the directory.	String	/	UTF-8
directory	The `Directory` to update.	Directory	/

Returns

Return Type	Description
Directory	the updated `Directory` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:update-group>

Update a group.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
groupId	The unique identifier of the group.	String	/	UTF-8
group	The `Group` to update.	Group	/

Returns

Return Type	Description
Group	the updated `Group` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.

<stormpath:update-tenant>

Update a tenant.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
tenantId	The unique identifier of the tenant (`current` is not a valid value).	String	/	UTF-8
tenant	A `Tenant` instance.	Tenant	/

Returns

Return Type	Description
Tenant	the updated `Tenant` instance.

Exception Payloads

Payload Class	Description
IOException	if anything goes wrong with the operation.