Access Management API

1.0.0

Overview

Statistics
267 Operations
6 Skills
Access & Identity Category
Manage access control, identity, and authorization for the Anypoint Platform. Create and configure organizations, environments, role-based access control (RBAC), teams, connected applications (OAuth clients), identity providers, and client credentials.

Servers

  • https://anypoint.mulesoft.com/accounts/api The server for the US region
  • https://{region}.anypoint.mulesoft.com/accounts/api The server for the EU region
  • https://{region}.platform.mulesoft.com/accounts/api The server for a specific region

Authentication & Security

  • oauth_2_0_raml_1_0 oauth2

    OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password. This is preferred over Basic Authentication because tokens can be limited to specific types of data, and can be revoked by users at any time. Use apiportal for the client_id

  • basic http

    This endpoint supports Basic Authentication.

  • bearerAuth http

    Bearer token authentication for API access.

  • clientAuth http

    Client credentials authentication token.

List Authorize listAuthorize

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Authorize for a single resource

Query Parameters

namespace *: string
The permission namespace to check authorization against (e.g., cloudhub, exchange).
action *: string
The action to authorize (e.g., GET, POST, PUT, DELETE).
resource *: string
The resource path to check authorization for.

Request Body

json
namespace *: string
The permission namespace the operation applies to (for example, cloudhub or exchange).
action *: string
The action authorized by the operation (for example, GET, POST, PUT, DELETE).
resource *: string
The resource path the operation authorizes against.
Examples
application/json
{ "namespace": "namespace", "action": "GET", "resource": "/api" }

Response

Create Authorize createAuthorize

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Authorize for many resources

Request Body

json
namespace *: string
The permission namespace the operation applies to (for example, cloudhub or exchange).
action *: string
The action authorized by the operation (for example, GET, POST, PUT, DELETE).
resources *: array
The list of resources affected by the request.
Examples
application/json
{ "namespace": "namespace", "action": "GET", "resources": [ "/api/users", "/api/clients" ] }

Response

json
items: array
Response payload for createAuthorize.
Examples
application/json
[ "/api/users", "/api/clients" ]

List Authorize Client listAuthorizeClient

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Authorizes a client application for access to a specific resource using client credentials.

Query Parameters

client_id *: string
The unique identifier of the client application.
client_secret *: string
The secret credential for the client application.
namespace *: string
The permission namespace to check authorization against (e.g., cloudhub, exchange).
action *: string
The action to authorize (e.g., GET, POST, PUT, DELETE).
resource *: string
The resource path to check authorization for.

Request Body

json
client_id *: string
The unique identifier of the client application.
client_secret *: string
The client secret used to authenticate the application when requesting tokens.
namespace *: string
The permission namespace the operation applies to (for example, cloudhub or exchange).
action *: string
The action authorized by the operation (for example, GET, POST, PUT, DELETE).
resource *: string
The resource path the operation authorizes against.
Examples
application/json
{ "client_id": "cid", "client_secret": "secret", "namespace": "namespace", "action": "GET", "resource": "/api" }

Response

Create Authorize Context createAuthorizeContext

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Get the set of contexts in which the caller can perform an action on resources that match a template

Request Body

json
namespace *: string
the namespace for the resources defined in the resource template
actions: array
which actions to return results for. If not provided, results for all actions are returned.
resourceTemplates *: array
simplify: boolean
limit: integer
return a maximum of this many results
offset: integer

Response

json
Success
data *: array
total *: number
Examples
application/json
{ "data": [ { "namespace": "cloudhub", "resource": "/organizations/614b40bf-6eb6-49ac-82f4-d8332b6f4d1b/environments/a4685c7a-08fe-45d7-9e29-87b84223d251/applications", "resourceTemplate": "/organizations/{{org}}/environments/{{envId}}/applications", "resourceTemplateParams": { "org": "614b40bf-6eb6-49ac-82f4-d8332b6f4d1b", "envId": "a4685c7a-08fe-45d7-9e29-87b84223d251" }, "actions": [ "GET" ] }, { "namespace": "cloudhub", "resource": "/organizations/614b40bf-6eb6-49ac-82f4-d8332b6f4d1b/environments/05e35d44-405a-4693-81ce-4e78e9a72891/applications", "resourceTemplate": "/organizations/{{org}}/environments/{{envId}}/applications", "resourceTemplateParams": { "org": "614b40bf-6eb6-49ac-82f4-d8332b6f4d1b", "envId": "05e35d44-405a-4693-81ce-4e78e9a72891" }, "actions": [ "GET" ] }, { "namespace": "cloudhub", "resource": "/organizations/d71ef2da-40cf-415b-80fd-eab0a7130bc8/environments/*/applications", "resourceTemplate": "/organizations/{{org}}/environments/{{envId}}/applications", "resourceTemplateParams": { "org": "d71ef2da-40cf-415b-80fd-eab0a7130bc8", "envId": "*" }, "actions": [ "GET" ] } ], "total": 3 }

List Clients listClients

GET

Try it out

Custom Query Parameters
Custom Headers
Get all clients

Response

json
ac_client *: object
The client used by the platform to perform authorization-code flows.
rs_client *: object
The client used by the platform to perform resource-server operations.
ro_client *: object
The client used by the platform to perform resource-owner operations.
cc_client *: object
The client used by the platform to perform client-credentials flows.
im_client *: object
The client used by the platform to integrate with the identity manager.
cp_client *: object
The client used by the platform to communicate with the control plane.
Examples
application/json
{ "ac_client": { "client_id": "ac_client", "name": "Authorization Code", "redirect_uris": [ "http://localhost:3004/auth/callback" ], "grant_types": [ "authorization_code", "refresh_token" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, "rs_client": { "client_id": "rs_client", "name": "Resource Server", "grant_types": [ "validate_bearer" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, "ro_client": { "client_id": "ro_client", "name": "Resource Owner", "grant_types": [ "password", "refresh_token" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, "cc_client": { "client_id": "cc_client", "name": "Client Credentials", "grant_types": [ "client_credentials" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, "im_client": { "client_id": "im_client", "name": "Implicit", "redirect_uris": [ "http://localhost:3004/auth/callback" ], "grant_types": [ "implicit", "validate_bearer" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, "cp_client": { "client_id": "cp_client", "name": "Client Credentials", "redirect_uris": [ "http://localhost:3004/auth/callback" ], "grant_types": [ "client_credentials" ], "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb", "client_management_provider_id": "b732985a-d30f-11e9-bb65-2a2ae2dbcce4" } }

Create Clients createClients

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Create a new client

Request Body

json
client_id *: string
The unique identifier of the client application.
client_secret *: string
The client secret used to authenticate the application when requesting tokens.
name *: string
The display name of the resource.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
properties *: object
Additional properties associated with the resource.
org_id *: string
The unique identifier of the organization.
Examples
application/json
{ "client_id": "im_client", "client_secret": "changeme", "name": "Implicit", "redirect_uris": [ "http://localhost/callback" ], "grant_types": [ "implicit" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }

Response

json
client_id *: string
The unique identifier of the client application.
name *: string
The display name of the resource.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
properties *: object
Additional properties associated with the resource.
org_id *: string
The unique identifier of the organization.
Examples
application/json
{ "client_id": "im_client", "name": "Implicit", "redirect_uris": [ "http://localhost/callback" ], "grant_types": [ "implicit" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }

Get Clients getClients

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get a single client

Path Parameters

clientId *: string

Response

json
client_id *: string
The unique identifier of the client application.
name *: string
The display name of the resource.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
properties *: object
Additional properties associated with the resource.
org_id *: string
The unique identifier of the organization.
Examples
application/json
{ "client_id": "im_client", "name": "Implicit", "redirect_uris": [ "http://localhost/callback" ], "grant_types": [ "implicit" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }

Update Clients updateClients

PATCH

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single client

Path Parameters

clientId *: string

Query Parameters

resetSecret *: boolean
Asks service to reset secret as part of this operation

Request Body

json
client_id *: string
The unique identifier of the client application.
name *: string
The display name of the resource.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
properties *: object
Additional properties associated with the resource.
org_id *: string
The unique identifier of the organization.
Examples
application/json
{ "client_id": "im_client", "name": "Implicit", "redirect_uris": [ "http://localhost/callback" ], "grant_types": [ "implicit" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }

Response

Delete Clients deleteClients

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes a single client

Path Parameters

clientId *: string

Response

List Clients Roles listClientsRoles

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Return a list of roles that are assigned to a client

Path Parameters

clientId *: string

Response

json
items: array
Response payload for listClientsRoles.
Examples
application/json
[ { "client_role_id": "40460a62-bbdc-469d-9330-5eec892abd05", "role_id": "20460a62-bbdc-469d-9330-5eec892abd05", "context_params": { "org": "ms", "env": "test" } } ]

Create Clients Roles createClientsRoles

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Assign a list of roles to a client

Path Parameters

clientId *: string

Request Body

json
20460a62-bbdc-469d-9330-5eec892abd05 *: object
Per-resource entry keyed by identifier.
20460a62-bbdc-469d-9660-5eec892abd05 *: object
Per-resource entry keyed by identifier.
Examples
application/json
{ "20460a62-bbdc-469d-9330-5eec892abd05": { "org": "ms", "env": "test" }, "20460a62-bbdc-469d-9660-5eec892abd05": { "org": "ms", "env": "dev" } }

Response

Delete Clients Roles deleteClientsRoles

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Unassign a list of roles from a client

Path Parameters

clientId *: string

Request Body

json
20460a62-bbdc-469d-9330-5eec892abd05 *: object
Per-resource entry keyed by identifier.
20460a62-bbdc-469d-9660-5eec892abd05 *: object
Per-resource entry keyed by identifier.
Examples
application/json
{ "20460a62-bbdc-469d-9330-5eec892abd05": { "org": "ms", "env": "test" }, "20460a62-bbdc-469d-9660-5eec892abd05": { "org": "ms", "env": "dev" } }

Response

Get Clients Roles getClientsRoles

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Return a role is assigned to a client

Path Parameters

clientId *: string
roleId *: string

Response

json
items: array
Response payload for getClientsRoles.
Examples
application/json
[ { "client_role_id": "40460a62-bbdc-469d-9330-5eec892abd05", "role_id": "20460a62-bbdc-469d-9330-5eec892abd05", "context_params": { "org": "ms", "env": "test" } } ]

Create Client Role createClientRole

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Assign a role to a client

Path Parameters

clientId *: string
roleId *: string

Request Body

json
org *: string
The organization slug or short identifier used in API paths.
env *: string
The environment slug or short identifier used in API paths.
Examples
application/json
{ "org": "ms", "env": "test" }

Response

Delete Client Role deleteClientRole

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Unassign a role from a client

Path Parameters

clientId *: string
roleId *: string

Response

Create Clients Search createClientsSearch

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Search clients

Request Body

json
name: string | array
client_id: string | array
org_id: string | array
client_management_provider_id: string | array
Examples
application/json
{ "client_id": [ "client1", "client2" ] }

Response

json
Success
items: array
Response payload for createClientsSearch.
Examples
application/json
[ { "client_id": "ac_client", "name": "Authorization Code", "redirect_uris": [ "http://localhost:3004/auth/callback" ], "grant_types": [ "authorization_code", "refresh_token" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, { "client_id": "rs_client", "name": "Resource Server", "grant_types": [ "validate_bearer" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, { "client_id": "ro_client", "name": "Resource Owner", "grant_types": [ "password", "refresh_token" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, { "client_id": "cc_client", "name": "Client Credentials", "grant_types": [ "client_credentials" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, { "client_id": "im_client", "name": "Implicit", "redirect_uris": [ "http://localhost:3004/auth/callback" ], "grant_types": [ "implicit", "validate_bearer" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, { "client_id": "cp_client", "name": "Client Credentials", "redirect_uris": [ "http://localhost:3004/auth/callback" ], "grant_types": [ "client_credentials" ], "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb", "client_management_provider_id": "b732985a-d30f-11e9-bb65-2a2ae2dbcce4" } ]

List Connected Applications listConnectedApplications

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Get all connected applications for the organization

Query Parameters

includeUsage *: boolean
organizationId: string
hide_managed: boolean
offset: integer
limit: integer
search: string
A search string to use for case-insensitive partial matches on all object properties
sort: string
ascending *: boolean

Response

json
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "client_id": "0fa2aa2f0aeb4978b96796a0843f898c", "owner_org_id": "0eb65884-4f75-48f7-a8bc-4e30b46e721d", "client_name": "Client Credz", "client_secret": "B0313ad5a6B44f7ebb4Bf482C49327e1", "public_keys": [], "redirect_uris": [ "https://why.net" ], "grant_types": [ "client_credentials" ], "scopes": [], "enabled": true, "audience": "internal", "client_uri": null, "policy_uri": null, "tos_uri": null, "generate_iss_claim_without_token": true }, { "client_id": "e8c28f0249a6417bb892ff8d6013d628", "owner_org_id": "0eb65884-4f75-48f7-a8bc-4e30b46e721d", "client_name": "OpenID Integration", "client_secret": "eA0Fa9BaAe454F32A6Ae8ABBc1b730C0", "public_keys": [], "redirect_uris": [ "https://example.com" ], "grant_types": [ "implicit", "authorization_code", "refresh_token" ], "scopes": [ "full", "read:full", "openid", "profile", "email", "offline_access" ], "enabled": true, "audience": "internal", "client_uri": null, "policy_uri": null, "tos_uri": null, "generate_iss_claim_without_token": false } ], "total": 2 }

Create Connected Applications createConnectedApplications

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Create a new connected application

Request Body

json
grant_types: array
The grant types to be used with this app
client_name: string
enabled: boolean
owner_user_id: string
generate_iss_claim_without_token: boolean
public_keys: array
client_secret: string
client_id: string
tos_uri: string
scopes: array
The level of permissions to provide to the app
client_uri: string
redirect_uris *: array
Configure which URIs users should be directed to after authorization
owner_org_id: string
audience: string
Configure whether the app is internal to your company or is a third-party public app that can be distributed outside of your organization
policy_uri: string

Response

json
client_id *: string
The unique identifier of the client application.
owner_org_id *: string
The unique identifier of the organization that owns the resource.
client_name *: string
The display name of the client application.
client_secret *: string
The client secret used to authenticate the application when requesting tokens.
public_keys *: array
The public keys used to verify signatures issued by the resource.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
scopes *: array
The OAuth 2.0 scopes granted to the resource.
enabled *: boolean
Whether the feature or resource is currently enabled.
audience *: string
The audience (intended recipient) of the issued token, as defined by the OAuth 2.0 specification.
generate_iss_claim_without_token *: boolean
Whether the issuer claim should be generated when no access token is present.
Examples
application/json
{ "client_id": "0fa2aa2f0aeb4978b96796a0843f898c", "owner_org_id": "0eb65884-4f75-48f7-a8bc-4e30b46e721d", "client_name": "SampleClient", "client_secret": "B0313ad5a6B44f7ebb4Bf482C49327e1", "public_keys": [], "redirect_uris": [ "https://why.net" ], "grant_types": [ "client_credentials" ], "scopes": [], "enabled": true, "audience": "internal", "generate_iss_claim_without_token": true }

Get Connected Applications getConnectedApplications

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get a single connected application

Path Parameters

clientId *: string

Query Parameters

includeUsage *: boolean

Response

json
client_id *: string
The unique identifier of the client application.
owner_org_id *: string
The unique identifier of the organization that owns the resource.
client_name *: string
The display name of the client application.
client_secret *: string
The client secret used to authenticate the application when requesting tokens.
public_keys *: array
The public keys used to verify signatures issued by the resource.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
scopes *: array
The OAuth 2.0 scopes granted to the resource.
enabled *: boolean
Whether the feature or resource is currently enabled.
audience *: string
The audience (intended recipient) of the issued token, as defined by the OAuth 2.0 specification.
generate_iss_claim_without_token *: boolean
Whether the issuer claim should be generated when no access token is present.
Examples
application/json
{ "client_id": "0fa2aa2f0aeb4978b96796a0843f898c", "owner_org_id": "0eb65884-4f75-48f7-a8bc-4e30b46e721d", "client_name": "SampleClient", "client_secret": "B0313ad5a6B44f7ebb4Bf482C49327e1", "public_keys": [], "redirect_uris": [ "https://why.net" ], "grant_types": [ "client_credentials" ], "scopes": [], "enabled": true, "audience": "internal", "generate_iss_claim_without_token": true }

Update Connected Applications updateConnectedApplications

PATCH

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single connected application

Path Parameters

clientId *: string

Query Parameters

resetSecret: boolean

Request Body

json
client_id: string
client_name: string
client_secret: string
owner_org_id: string
owner_user_id: string
enabled: boolean
audience: string
Configure whether the app is internal to your company or is a third-party public app that can be distributed outside of your organization
client_uri: string
policy_uri: string
tos_uri: string
public_keys: array
grant_types: array
The grant types to be used with this app
redirect_uris: array
Configure which URIs users should be directed to after authorization
scopes: array
The level of permissions to provide to the app
generate_iss_claim_without_token: boolean

Response

json
Connected application was successfully updated
client_id *: string
The unique identifier of the client application.
owner_org_id *: string
The unique identifier of the organization that owns the resource.
client_name *: string
The display name of the client application.
client_secret *: string
The client secret used to authenticate the application when requesting tokens.
public_keys *: array
The public keys used to verify signatures issued by the resource.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
scopes *: array
The OAuth 2.0 scopes granted to the resource.
enabled *: boolean
Whether the feature or resource is currently enabled.
audience *: string
The audience (intended recipient) of the issued token, as defined by the OAuth 2.0 specification.
generate_iss_claim_without_token *: boolean
Whether the issuer claim should be generated when no access token is present.
Examples
application/json
{ "client_id": "0fa2aa2f0aeb4978b96796a0843f898c", "owner_org_id": "0eb65884-4f75-48f7-a8bc-4e30b46e721d", "client_name": "SampleClient", "client_secret": "B0313ad5a6B44f7ebb4Bf482C49327e1", "public_keys": [], "redirect_uris": [ "https://why.net" ], "grant_types": [ "client_credentials" ], "scopes": [], "enabled": true, "audience": "internal", "generate_iss_claim_without_token": true }

Delete Connected Applications deleteConnectedApplications

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes a single connected application

Path Parameters

clientId *: string

Response

Connected application was deleted

List Connected Applications Scopes listConnectedApplicationsScopes

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves context-aware scopes assigned to the connected application

Path Parameters

clientId *: string

Query Parameters

offset: integer
limit: integer

Response

json
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "scope": "example:scope", "context_params": { "org": "8b0b657c-91ca-420d-870a-08699094f5e4", "envId": "7cc0463b-f7be-418d-8a64-84fbad13ab00" } } ], "total": 1 }

Update Connected Applications Scopes updateConnectedApplicationsScopes

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Replaces the entire list of context-aware scopes assigned to the connected application

Path Parameters

clientId *: string

Request Body

json
scopes *: array
Examples
application/json
{ "scopes": [ { "scope": "example:scope", "context_params": { "org": "8b0b657c-91ca-420d-870a-08699094f5e4", "envId": "7cc0463b-f7be-418d-8a64-84fbad13ab00" } } ] }

Response

Connected application scopes were successfully replaced

Update Connected Application Scopes updateConnectedApplicationScopes

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Assigns additional context-aware scopes to the connected application.
Does not unassign any existing scopes.
Duplicate entries are ignored.

Path Parameters

clientId *: string

Request Body

json
scopes *: array
scopesToDelete: array
Examples
application/json
{ "scopes": [ { "scope": "example:scope1", "context_params": { "org": "8b0b657c-91ca-420d-870a-08699094f5e4", "envId": "7cc0463b-f7be-418d-8a64-84fbad13ab00" } } ], "scopesToDelete": [ { "scope": "example:scope2", "context_params": { "org": "8b0b657c-91ca-420d-870a-08699094f5e4", "envId": "7cc0463b-f7be-418d-8a64-84fbad13ab00" } } ] }

Response

Connected application scopes were successfully assigned

Delete Connected Applications Scopes deleteConnectedApplicationsScopes

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Unassigns context-aware scopes from the connected application.
Scopes must exactly match in order to be removed.

Path Parameters

clientId *: string

Request Body

json
scopes *: array
Examples
application/json
{ "scopes": [ { "scope": "example:scope", "context_params": { "org": "8b0b657c-91ca-420d-870a-08699094f5e4", "envId": "7cc0463b-f7be-418d-8a64-84fbad13ab00" } } ] }

Response

Connected application scopes were successfully unassigned

Delete Connected Applications Revoke deleteConnectedApplicationsRevoke

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Revoke all access tokens and refresh tokens issued to the connected application

Path Parameters

clientId *: string

Response

All tokens were revoked successfully

List Deleted Resources listDeletedResources

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
returns the deleted organizations

Query Parameters

deletedBefore *: string(date-time-only)
search for all organizations deleted before a certain date
deletedAfter *: string(date-time-only)
search for all organizations deleted after a certain date
parentOrgId *: string
search for all organizations deleted that are children of the specified orgnization
organizationId *: string

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "org_id": "2b4ae07b-321d-4364-8e16-4b655936a7b8", "parent_organization_ids": [ "3b4ae07b-321d-4364-8e16-4b655936a7b7", "4b4ae07b-321d-4364-8e16-4b655936a7b6" ], "environment_ids": [ "3b4ae07b-321d-4364-8e16-4bfsd936a7b7", "2b4ae07b-321d-4364-8e16-4b655adga7b7", "7b4ae07b-321d-4364-8e16-4b655aa3a7b6" ], "deleted_at": "2019-08-13T16:19:33.859000+00:00" } ], "total": 1 }

List Deleted Resources Environments listDeletedResourcesEnvironments

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
returns the deleted environments

Query Parameters

deletedBefore *: string(date-time-only)
search for all environments deleted before a certain date
deletedAfter *: string(date-time-only)
search for all environments deleted after a certain date
organizationId *: string
envId *: string
search for the environment deleted

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "environment_id": "3b4ae07b-321d-4364-8e16-4bfsd936a7b7", "organization_id": "2b4ae07b-321d-4364-8e16-4b655936a7b8", "deleted_at": "2019-08-13T16:19:33.859000+00:00", "deleted_through_org": true } ], "total": 1 }

Get Environments getEnvironments

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves an environment by id

Path Parameters

environmentId *: string

Response

json
Returns the environment
id *: string
The unique identifier of the resource.
organizationId *: string
The unique identifier of the organization.
name *: string
The display name of the resource.
isProduction *: boolean
Whether the environment is a production environment.
type *: string
The type of the resource.
clientId *: string
The unique identifier of the client application.
Examples
application/json
{ "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "70b3f7cb-614c-4276-b0cd-4f73db11602c", "name": "Development", "isProduction": false, "type": "sandbox", "clientId": "abdf31490ba44484a1de789baf685e37" }

Update Environments updateEnvironments

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update an environment, implemented as a patch. Note that only the name is allowed to be updated, isProduction and type can not.

Path Parameters

environmentId *: string

Request Body

json
name *: string
The display name of the resource.
organizationId *: string
The unique identifier of the organization.
Examples
application/json
{ "name": "FooBarEnv", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043" }

Response

json
Returns the updated environment
id *: string
The unique identifier of the resource.
organizationId *: string
The unique identifier of the organization.
name *: string
The display name of the resource.
isProduction *: boolean
Whether the environment is a production environment.
type *: string
The type of the resource.
clientId *: string
The unique identifier of the client application.
Examples
application/json
{ "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "70b3f7cb-614c-4276-b0cd-4f73db11602c", "name": "Development", "isProduction": false, "type": "sandbox", "clientId": "abdf31490ba44484a1de789baf685e37" }

Create Feature Flags Check createFeatureFlagsCheck

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
check a feature for a list or organizations

Path Parameters

featureFlagName *: string
The name of the feature flag to evaluate.

Request Body

json
items: array
Array items

Response

Too many requests

List Feature Flags Enabled listFeatureFlagsEnabled

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
get all enabled featureFlags includes organizations and additional context

Path Parameters

featureFlagName *: string
The name of the feature flag to evaluate.

Response

Too many requests

List Invites listInvites

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
get outstanding or expired invites that match the criteria

Query Parameters

organizationId *: string
offset: integer
limit: integer
search: string
A search string to use for case-insensitive partial matches on invited emails
sort: string
ascending *: boolean

Response

json
Success
data *: array
total *: number
Examples
application/json
{ "data": [ { "id": 520, "code": "f2e8dfab-6699-4889-831f-6dc6f8428cb0", "invited_at": "2015-01-30T22:23:55.433000+00:00", "invited_email": "christopher.mordue@mulesoft.com", "invited_by_user": { "id": "57e281b5-ec5b-4701-80a0-92a936a68da3", "username": "organization_owner", "first_name": "Organization2", "last_name": "Owner" }, "invited_to_org": { "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "name": "MuleSoft Inc" }, "expires_at": "2015-04-10T22:23:55.433000+00:00", "status": "INVITED", "completed_at": null, "completed_by_user": null, "role_groups": [ { "name": "Organization Administrators", "role_group_id": "0b19f6df-ed81-4fd1-b5e7-4921f5e46f4c" } ] } ], "total": 1 }

Create Invites createInvites

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Invite a person to join the organization

Request Body

json

Response

json
Success
items: array
Array items

Delete Invites deleteInvites

DELETE

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Invite a person to join your organization

Request Body

json
items: array
Array items

Response

Success

Get Invites getInvites

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
get an invite

Path Parameters

inviteId *: integer
The ID of the invite

Response

Success

List Invites Accept listInvitesAccept

GET

Try it out

Custom Query Parameters
Custom Headers
Redirect to anypoint signin to accept an invite

Response

Too many requests

Create Invites Resend createInvitesResend

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Resend a list of invites

Request Body

json
items: array
Array items

Response

json
Success
succeeded *: array
failed *: array

Create Login createLogin

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
login to the Anypoint Platform

Request Body

json
username *: string
The username used to authenticate the user.
password *: string
The user's password. Write-only.
Examples
application/json
{ "username": "testUser", "password": "Password1" }

Response

json
Returns the bearer token for the user's session
access_token *: string
The OAuth 2.0 access token issued to the client.
token_type *: string
The type of the issued token (typically 'Bearer').
Examples
application/json
{ "access_token": "d127e2ec-a703-4e2a-8629-e9158804748b", "token_type": "bearer" }

List Logout listLogout

GET

Try it out

Custom Query Parameters
Custom Headers
destroy the user's session and logout from the Anypoint Platform

Response

Success; logout was called via ajax so no redirect

List Me listMe

GET

Try it out

Custom Query Parameters
Custom Headers
Retrieve information about the caller

Response

json
Success
client *: object
The client application associated with the resource.
user *: object
The user associated with the resource.
Examples
application/json
{ "client": { "client_id": "asdflkjlsdf09234oiuWERmn", "name": "Admin Client", "redirect_uris": [], "grant_types": [ "authorization_code", "refresh_token", "validate_bearer", "password", "client_credentials", "implicit" ] }, "user": { "id": "a23c0943-1cc4-47f1-aea2-cb6c2c2fca6a", "createdAt": "2014-07-27T20:56:02.112000+00:00", "updatedAt": "2014-12-17T15:57:40.250000+00:00", "lastLogin": "2014-12-17T15:57:40.250000+00:00", "previousLastLogin": "2014-12-16T15:57:40.250000+00:00", "firstName": "Chris", "lastName": "Mordue", "email": "christopher.mordue@mulesoft.com", "phoneNumber": "+1 123-456-7890", "username": "sundaycmordue", "enabled": true, "deleted": false, "idprovider_id": "mulesoft", "type": "host", "organizationPreferences": { "0a14e2fd-1cfe-4310-acbc-54bf93eb8420": { "defaultEnvironment": "a6217e66-faf1-4c17-bbbc-8c008ef4c8c6" } }, "organizationId": "0a14e2fd-1cfe-4310-acbc-54bf93eb8420", "organization": { "name": "Mordue's Sundays testing", "id": "0a14e2fd-1cfe-4310-acbc-54bf93eb8420", "createdAt": "2014-07-27T20:56:02.125000+00:00", "ownerId": "a23c0943-1cc4-47f1-aea2-cb6c2c2fca6a", "updatedAt": "2015-01-29T18:34:54.570000+00:00", "clientId": "3b8650722f5847b1abf51f769c173514", "domain": "mordues-sundays", "isFederated": false, "parentOrganizationIds": [], "subOrganizationIds": [], "tenantOrganizationIds": [], "idprovider_id": "mulesoft", "properties": { "cs_auth": { "session_timeout": 1200000 }, "defaultAccessManagementUi": "cs-ui" }, "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" }, "entitlements": { "partnersProduction": { "assigned": 0 }, "partnersSandbox": { "assigned": 0 }, "tradingPartnersProduction": { "assigned": 0 }, "tradingPartnersSandbox": { "assigned": 0 }, "createSubOrgs": false, "createEnvironments": false, "hybrid": { "enabled": false }, "globalDeployment": false, "vCoresProduction": { "assigned": 1, "reassigned": 0 }, "vCoresSandbox": { "assigned": 1, "reassigned": 0 }, "vCoresDesign": { "assigned": 1, "reassigned": 0 }, "staticIps": { "assigned": 1, "reassigned": 0 }, "vpcs": { "assigned": 0, "reassigned": 0 }, "vpns": { "assigned": 0, "reassigned": 0 }, "networkConnections": { "assigned": 0, "reassigned": 0 }, "workerLoggingOverride": { "enabled": false }, "messaging": { "assigned": 0 }, "mqMessages": { "base": 0, "addOn": 0 }, "mqRequests": { "base": 0, "addOn": 0 }, "mqAdvancedFeatures": { "enabled": false }, "objectStoreRequestUnits": { "base": 0, "addOn": 0 }, "objectStoreKeys": { "base": 0, "addOn": 0 }, "gateways": { "assigned": 0 }, "designCenter": { "mozart": true, "api": true, "apiVisual": false, "apiExample": false }, "loadBalancer": { "assigned": 0, "reassigned": 0 }, "externalIdentity": true, "autoscaling": false, "armAlerts": false, "hybridInsight": true, "hybridAutoDiscoverProperties": true, "apis": { "enabled": true }, "apiCatalog": { "enabled": false }, "apiMonitoring": { "schedules": 0 }, "apiCommunityManager": { "enabled": false }, "apiExperienceHub": { "enabled": false }, "monitoringCenter": { "productSKU": 3, "rawStorageOverrideGB": 0, "dataRegion": "us-east-1", "productionUnits": 0, "preProductionUnits": 0, "storageBase": 0, "storageAddOn": 0 }, "apiQuery": { "enabled": false, "productSKU": 1 }, "apiQueryC360": { "enabled": false }, "rpa": { "enabled": false, "active": false, "composerVersion": "" }, "idp": { "enabled": false }, "AutomationCreditsDW": { "assigned": 0 }, "apiGovernance": { "enabled": true, "apisPerMonth": 5 }, "apiGovernanceDomain": { "domain": "ASSET" }, "crowd": { "hideApiManagerDesigner": false, "hideFormerApiPlatform": false, "environments": false }, "cam": { "enabled": false }, "exchange2": { "enabled": false, "assetUsageAndEngagement": { "enabled": false } }, "crowdSelfServiceMigration": { "enabled": false }, "kpiDashboard": { "enabled": false }, "pcf": false, "appViz": false, "workerClouds": { "assigned": 0, "reassigned": 0 }, "runtimeFabric": false, "serviceMesh": { "enabled": false }, "flexGateway": { "enabled": false }, "managedGatewaySmall": { "assigned": 0, "reassigned": 0 }, "managedGatewayLarge": { "assigned": 0, "reassigned": 0 }, "rtfManagedGateway": { "enabled": false }, "runtimeFabricCloud": { "enabled": false }, "composer": { "enabled": false, "tasksPerMonth": 100, "maxConnectors": 3, "unlimitedConnectors": false, "isHyperAutomation": false }, "muleDxWebIde": { "enabled": false }, "muleDxGenAI": { "enabled": false }, "muleDxEDA": { "enabled": false }, "usageBasedPricing": { "muleRuntimeIntegration": { "enabled": true, "flows": 100, "messages": 10000, "throughput": 10000000 } }, "usageBasedPricingLimits": { "cpu": { "base": 10.01, "extra": 0.01 }, "memory": { "base": 1.02, "extra": 20.01 } }, "highAvailability": { "clustering": false }, "cloudhub1": { "enabled": true }, "telemetryExporter": { "enabled": true } }, "isRoot": true, "isMaster": true }, "memberOfOrganizations": [ { "name": "Mordue's Sundays testing", "id": "0a14e2fd-1cfe-4310-acbc-54bf93eb8420", "createdAt": "2014-07-27T20:56:02.125000+00:00", "ownerId": "a23c0943-1cc4-47f1-aea2-cb6c2c2fca6a", "updatedAt": "2015-01-29T18:34:54.570000+00:00", "clientId": "3b8650722f5847b1abf51f769c173514", "domain": "mordues-sundays", "isFederated": false, "parentOrganizationIds": [], "parentId": null, "parentName": null, "subOrganizationIds": [], "tenantOrganizationIds": [], "idprovider_id": "mulesoft", "isRoot": true, "isMaster": true, "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" } } ], "contributorOfOrganizations": [ { "name": "Mordue's Sundays testing", "id": "0a14e2fd-1cfe-4310-acbc-54bf93eb8420", "createdAt": "2014-07-27T20:56:02.125000+00:00", "ownerId": "a23c0943-1cc4-47f1-aea2-cb6c2c2fca6a", "updatedAt": "2015-01-29T18:34:54.570000+00:00", "clientId": "3b8650722f5847b1abf51f769c173514", "domain": "mordues-sundays", "isFederated": false, "parentOrganizationIds": [], "parentId": null, "parentName": null, "subOrganizationIds": [], "tenantOrganizationIds": [], "idprovider_id": "mulesoft", "isRoot": true, "isMaster": true, "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" } } ], "properties": {} } }

Create Notifications createNotifications

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new notifications.

Request Body

json
type *: string
The type of the resource.
action *: string
The action authorized by the operation (for example, GET, POST, PUT, DELETE).
organizationId *: string
The unique identifier of the organization.
userId *: string
The unique identifier of the user.
dateTime *: string
A date and time value in ISO 8601 format.
object *: object
The object affected by the operation.
Examples
application/json
{ "type": "api", "action": "create", "organizationId": "0a14e2fd-1cfe-4310-acbc-54bf93eb8420", "userId": "a23c0943-1cc4-47f1-aea2-cb6c2c2fca6a", "dateTime": "2014-07-27T20:56:02.146000+00:00", "object": { "apiId": 1077, "apiName": "Anypoint Notifications", "description": "Notifications API to let subscribers know of changes in the Anypoint Platform. Think Webhooks.", "id": 973, "name": "0.1" } }

Response

Success

List Oauth2Authorize listOauth2Authorize

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
OAuth2 authorization route to have the user authorize an application defined in our system

Query Parameters

redirect_uri *: string
Redirect uri for the application
response_type *: string
Describes the type of object that the application wishes to receive upon success
client_id *: string
The application's client_id that identifies the application
state *: string
A parameter with a string that will be supplied in a redirect back to the application upon success

Response

Success; redirects the user to the page to authentication & authorize the application if not logged in, or to the original application if logged in

List Oauth2Authorize By Domain listOauth2AuthorizeByDomain

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
OAuth2 authorization route that will route federated users to their authentication system and non-federated users to ours

Path Parameters

domain *: string
Domain name to identify the organization to identify what identity management system needs to authentication the user.

Query Parameters

redirect_uri *: string
Redirect uri for the application
response_type *: string
Describes the type of object that the application wishes to receive upon success
client_id *: string
The application's client_id that identifies the application
state *: string
A parameter with a string that will be supplied in a redirect back to the application upon success

Response

Success; redirects the user to the page to authentication & authorize the application if not logged in, or to the original application if logged in

Get Oauth2Authorize Providers getOauth2AuthorizeProviders

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
OAuth2 authorization route that will route federated users to their authentication system

Path Parameters

domain *: string
Domain name to identify the organization to identify what identity management system needs to authentication the user.
providerId *: string
The identity provider configuration id used to identify the identity management system needed to authenticate the user.

Query Parameters

redirect_uri *: string
Redirect uri for the application
response_type *: string
Describes the type of object that the application wishes to receive upon success
client_id *: string
The application's client_id that identifies the application
state *: string
A parameter with a string that will be supplied in a redirect back to the application upon success

Response

Success; redirects the user to the page to authentication & authorize the application if not logged in, or to the original application if logged in

Create Oauth2Decision createOauth2Decision

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Confirms whether a user grants consent to add his user to an external organization

Path Parameters

domain *: string
Domain name to identify the organization to identify what identity management system needs to authentication the user.

Response

Redirects the user to domain authorization flow

Create Oauth2Introspect createOauth2Introspect

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Look up caller information from an access token
This implements RFC-7662: OAuth 2.0 Token Introspection

Request Body

json
token *: string
token_type_hint: string
token *: string
token_type_hint: string
Examples
application/json
{ "token": "b8071e09-ece8-4edd-85f4-76a30cb732f6", "token_type_hint": "access_token" }
application/x-www-form-urlencoded
{ "token": "b8071e09-ece8-4edd-85f4-76a30cb732f6", "token_type_hint": "access_token" }

Response

success
Examples
application/json
{ "active": true, "token_type": "bearer", "user_id": "40e238d8-9f6c-495f-b000-0029f5576041", "username": "paul.hilfinger", "client_id": null, "iat": 1539823220995, "exp": 1539857830528 }

Create Oauth2Token createOauth2Token

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
create or retrieve an OAuth2 token

Request Body

json
grant_type *: string
The OAuth 2.0 grant type used in the request.
redirect_uri *: string(uri)
The redirect URI the user is sent to after authorization completes.
client_id *: string
The unique identifier of the client application.
client_secret *: string
The client secret used to authenticate the application when requesting tokens.
code *: string
The OAuth 2.0 authorization code returned to the client.
Examples
application/json
{ "grant_type": "authorization_code", "redirect_uri": "http://localhost/callback", "client_id": "ro_client", "client_secret": "th3S3cr3t", "code": "20460a62-bbdc-469d-9330-5eec892abd05" }

Response

success

Get Organizationname getOrganizationname

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Check if organization name is being used

Path Parameters

organizationName *: string
The name of the organization

Response

The organization name is already taken

Get Organizations getOrganizations

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns the referenced organization. In platform terms, Business Group scope for APIs such as
API Manager is identified by either id (this org) or any subOrganizationIds entry (child
Business Group); downstream organizationId path params accept any of those GUIDs when the
resource lives under that group.

The response body includes:
  • id — GUID of this organization.
  • subOrganizationIds — GUIDs of child organizations (each valid as organizationId where the

resource is under that subgroup).
  • environments — snapshot of environments for this org (may be partial). For a reliable

environmentId in API Manager, prefer listEnvironments (GET /organizations/{organizationId}/environments)
and use data[].id.
Also returns entitlements, owner, domain, and related metadata.

Path Parameters

organizationId *: string

Response

json
Success. Body includes organization id, subOrganizationIds, optional embedded environments, and entitlements.
name *: string
The display name of the resource.
id *: string
The unique identifier of the resource.
createdAt *: string
The date and time when the resource was created, in ISO 8601 format.
updatedAt *: string
The date and time when the resource was last updated, in ISO 8601 format.
ownerId *: string
The unique identifier of the user who owns the resource.
clientId *: string
The unique identifier of the client application.
domain *: string
The domain name associated with the organization.
idprovider_id *: string
The unique identifier of the identity provider.
isFederated *: boolean
Whether the organization uses a federated identity provider for authentication.
orgType *: string
The classification of the organization (for example, customer, partner, internal).
parentOrganizationIds *: array
Identifiers of the organizations that are ancestors of this organization in the hierarchy.
subOrganizationIds *: array
Identifiers of the organizations that are direct children of this organization.
entitlements *: object
The features and capabilities the organization is entitled to use.
environments *: array
The environments configured for the organization.
tenantOrganizationIds *: array
Identifiers of the tenant organizations associated with this organization.
isRoot *: boolean
Whether the organization is the root organization in the hierarchy.
isMaster *: boolean
Whether the organization is the master organization.
sessionTimeout *: integer
Length of an authenticated session before re-authentication is required, in milliseconds.
properties *: object
Additional properties associated with the resource.
owner *: object
The user or entity that owns the resource.
subscription *: object
The subscription that controls the entitlements available to the organization.
salesforce *: object
Configuration of the Salesforce integration for the organization.
Examples
application/json
{ "name": "MuleSoft Inc", "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "createdAt": "2015-03-13T18:03:23.869000+00:00", "updatedAt": "2015-03-13T18:03:24.207000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "clientId": "b63237d9c5d444ea95147065e0711161", "domain": "mulesoft-inc", "idprovider_id": "mulesoft", "isFederated": false, "orgType": "anypoint", "parentOrganizationIds": [], "subOrganizationIds": [ "07fd6c5b-0036-48a3-b2af-3194c06bed6c" ], "entitlements": { "hybrid": { "enabled": true }, "hybridInsight": false, "hybridAutoDiscoverProperties": true, "createEnvironments": true, "globalDeployment": true, "createSubOrgs": true, "vCoresProduction": { "assigned": 1, "reassigned": 0 }, "vCoresSandbox": { "assigned": 1, "reassigned": 0 }, "vCoresDesign": { "assigned": 1, "reassigned": 0 }, "staticIps": { "assigned": 1, "reassigned": 0 }, "vpcs": { "assigned": 0, "reassigned": 0 }, "vpns": { "assigned": 0, "reassigned": 0 }, "networkConnections": { "assigned": 0, "reassigned": 0 }, "workerLoggingOverride": { "enabled": false }, "messaging": { "assigned": 0 }, "mqMessages": { "base": 0, "addOn": 0 }, "mqRequests": { "base": 0, "addOn": 0 }, "mqAdvancedFeatures": { "enabled": false }, "objectStoreRequestUnits": { "base": 0, "addOn": 0 }, "objectStoreKeys": { "base": 0, "addOn": 0 }, "gateways": { "assigned": 0 }, "designCenter": { "mozart": true, "api": true, "apiVisual": false, "apiExample": false }, "partnersProduction": { "assigned": 0 }, "partnersSandbox": { "assigned": 0 }, "tradingPartnersProduction": { "assigned": 0 }, "tradingPartnersSandbox": { "assigned": 0 }, "loadBalancer": { "assigned": 1, "reassigned": 0 }, "externalIdentity": true, "autoscaling": false, "armAlerts": false, "apis": { "enabled": true }, "apiCatalog": { "enabled": false }, "apiMonitoring": { "schedules": 0 }, "apiCommunityManager": { "enabled": false }, "apiExperienceHub": { "enabled": false }, "monitoringCenter": { "productSKU": 3, "rawStorageOverrideGB": 0, "dataRegion": "us-east-1", "productionUnits": 0, "preProductionUnits": 0, "storageBase": 0, "storageAddOn": 0 }, "apiQuery": { "enabled": false, "productSKU": 1 }, "apiQueryC360": { "enabled": false }, "rpa": { "enabled": false, "active": false, "composerVersion": "" }, "idp": { "enabled": false }, "AutomationCreditsDW": { "assigned": 0 }, "apiGovernance": { "enabled": true, "apisPerMonth": 5 }, "apiGovernanceDomain": { "domain": "ASSET" }, "crowd": { "hideApiManagerDesigner": false, "hideFormerApiPlatform": false, "environments": false }, "cam": { "enabled": false }, "exchange2": { "enabled": false, "assetUsageAndEngagement": { "enabled": false } }, "crowdSelfServiceMigration": { "enabled": false }, "kpiDashboard": { "enabled": false }, "pcf": false, "appViz": false, "workerClouds": { "assigned": 0, "reassigned": 0 }, "runtimeFabric": false, "serviceMesh": { "enabled": false }, "flexGateway": { "enabled": false }, "managedGatewaySmall": { "assigned": 0, "reassigned": 0 }, "managedGatewayLarge": { "assigned": 0, "reassigned": 0 }, "rtfManagedGateway": { "enabled": false }, "runtimeFabricCloud": { "enabled": false }, "composer": { "enabled": false, "tasksPerMonth": 100, "maxConnectors": 3, "unlimitedConnectors": false, "isHyperAutomation": false }, "muleDxWebIde": { "enabled": false }, "muleDxGenAI": { "enabled": false }, "muleDxEDA": { "enabled": false }, "usageBasedPricing": { "muleRuntimeIntegration": { "enabled": true, "flows": 100, "messages": 10000, "throughput": 10000000 } }, "usageBasedPricingLimits": { "cpu": { "base": 10.01, "extra": 0.01 }, "memory": { "base": 1.02, "extra": 20.01 } }, "highAvailability": { "clustering": false }, "cloudhub1": { "enabled": true }, "telemetryExporter": { "enabled": true }, "anypointSecurityEdgePolicies": { "enabled": false }, "anypointSecurityTokenization": { "enabled": false }, "apiManager": { "governance": { "enabled": false }, "usageBasedPricing": { "api": { "production": { "amount": 0 }, "sandbox": { "amount": 0 } } }, "nonSplitPolicyModelDeprecated": false } }, "environments": [ { "id": "70b3f7cb-614c-4276-b0cd-4f73db11602c", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "name": "Production", "isProduction": true, "clientId": "abdf31490ba44484a1de789baf685e37" } ], "tenantOrganizationIds": [], "isRoot": true, "isMaster": true, "sessionTimeout": 60, "properties": { "defaultAccessManagementUi": "cs-ui" }, "owner": { "id": "5197cdf3-36c9-4bcb-8840-5779e961c746", "createdAt": "2015-01-29T00:00:53.315000+00:00", "updatedAt": "2015-01-29T00:00:55.163000+00:00", "lastLogin": "2015-01-29T00:00:55.163000+00:00", "previousLastLogin": "2015-01-28T00:00:55.163000+00:00", "firstName": "Organization", "lastName": "Owner", "email": "core_services@mulesoft.com", "phoneNumber": "111-111-1111", "username": "max", "enabled": true, "deleted": false, "idprovider_id": "mulesoft", "type": "host", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043" }, "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" }, "salesforce": { "sf_org_id": "00DSG00000CoJa78Ab", "apiEndpoint": "https://example.my.salesforce.com" } }

Update Organizations updateOrganizations

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the referenced organization

Path Parameters

organizationId *: string

Request Body

json
name *: string
The display name of the resource.
ownerId *: string
The unique identifier of the user who owns the resource.
idprovider_id *: string
The unique identifier of the identity provider.
properties *: object
Additional properties associated with the resource.
sessionTimeout *: integer
Length of an authenticated session before re-authentication is required, in milliseconds.
entitlements *: object
The features and capabilities the organization is entitled to use.
Examples
application/json
{ "name": "core services", "ownerId": "6db86c8c-535c-45e4-b7d7-45049c39b69b", "idprovider_id": "mulesoft.com:core-services", "properties": { "identity_management": { "saml": { "name": "SAML 2.0" } }, "defaultAccessManagementUi": "cs-ui" }, "sessionTimeout": 60, "entitlements": { "hybridInsight": false, "hybridAutoDiscoverProperties": true, "createEnvironments": false, "globalDeployment": false, "createSubOrgs": true, "vCoresProduction": { "assigned": 0.5 }, "vCoresSandbox": { "assigned": 0 }, "staticIps": { "assigned": 0 }, "vpcs": { "assigned": 0, "reassigned": 0 }, "vpns": { "assigned": 0, "reassigned": 0 }, "networkConnections": { "assigned": 0, "reassigned": 0 }, "workerLoggingOverride": { "enabled": false }, "partnersProduction": { "assigned": 0 }, "partnersSandbox": { "assigned": 0 }, "tradingPartnersProduction": { "assigned": 0 }, "tradingPartnersSandbox": { "assigned": 0 }, "designCenter": { "mozart": true, "api": true, "apiVisual": false, "apiExample": false }, "apiMonitoring": { "schedules": 0 }, "apiCatalog": { "enabled": false }, "apiCommunityManager": { "enabled": false }, "apiExperienceHub": { "enabled": false }, "monitoringCenter": { "productSKU": 3, "rawStorageOverrideGB": 0, "dataRegion": "us-east-1", "productionUnits": 0, "preProductionUnits": 0, "storageBase": 0, "storageAddOn": 0 }, "apiQuery": { "enabled": false, "productSKU": 1 }, "apiQueryC360": { "enabled": false }, "rpa": { "enabled": false, "active": false, "composerVersion": "" }, "idp": { "enabled": false }, "AutomationCreditsDW": { "assigned": 0 }, "apiGovernance": { "enabled": true, "apisPerMonth": 5 }, "apiGovernanceDomain": { "domain": "ASSET" }, "workerClouds": { "assigned": 0, "reassigned": 0 }, "runtimeFabric": false, "serviceMesh": { "enabled": false }, "flexGateway": { "enabled": false }, "managedGatewaySmall": { "assigned": 0, "reassigned": 0 }, "managedGatewayLarge": { "assigned": 0, "reassigned": 0 }, "rtfManagedGateway": { "enabled": false }, "runtimeFabricCloud": { "enabled": false }, "composer": { "enabled": false, "tasksPerMonth": 100, "maxConnectors": 3, "unlimitedConnectors": false, "isHyperAutomation": false }, "muleDxWebIde": { "enabled": false }, "muleDxGenAI": { "enabled": false }, "muleDxEDA": { "enabled": false }, "usageBasedPricing": { "muleRuntimeIntegration": { "enabled": true, "flows": 100, "messages": 10000, "throughput": 10000000 } }, "usageBasedPricingLimits": { "cpu": { "base": 10.01, "extra": 0.01 }, "memory": { "base": 1.02, "extra": 20.01 } }, "highAvailability": { "clustering": true }, "cloudhub1": { "enabled": true } } }

Response

json
Success
name *: string
The display name of the resource.
id *: string
The unique identifier of the resource.
createdAt *: string
The date and time when the resource was created, in ISO 8601 format.
updatedAt *: string
The date and time when the resource was last updated, in ISO 8601 format.
ownerId *: string
The unique identifier of the user who owns the resource.
clientId *: string
The unique identifier of the client application.
domain *: string
The domain name associated with the organization.
idprovider_id *: string
The unique identifier of the identity provider.
isFederated *: boolean
Whether the organization uses a federated identity provider for authentication.
parentOrganizationIds *: array
Identifiers of the organizations that are ancestors of this organization in the hierarchy.
subOrganizationIds *: array
Identifiers of the organizations that are direct children of this organization.
entitlements *: object
The features and capabilities the organization is entitled to use.
tenantOrganizationIds *: array
Identifiers of the tenant organizations associated with this organization.
isRoot *: boolean
Whether the organization is the root organization in the hierarchy.
isMaster *: boolean
Whether the organization is the master organization.
sessionTimeout *: integer
Length of an authenticated session before re-authentication is required, in milliseconds.
properties *: object
Additional properties associated with the resource.
subscription *: object
The subscription that controls the entitlements available to the organization.
Examples
application/json
{ "name": "MuleSoft Inc", "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "createdAt": "2015-03-13T18:03:23.869000+00:00", "updatedAt": "2015-03-13T18:03:24.207000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "clientId": "b63237d9c5d444ea95147065e0711161", "domain": "mulesoft-inc", "idprovider_id": "mulesoft", "isFederated": false, "parentOrganizationIds": [], "subOrganizationIds": [ "07fd6c5b-0036-48a3-b2af-3194c06bed6c" ], "entitlements": { "hybrid": { "enabled": true }, "hybridInsight": false, "hybridAutoDiscoverProperties": true, "createEnvironments": true, "globalDeployment": true, "createSubOrgs": true, "vCoresProduction": { "assigned": 1, "reassigned": 0 }, "vCoresSandbox": { "assigned": 1, "reassigned": 0 }, "vCoresDesign": { "assigned": 1, "reassigned": 0 }, "staticIps": { "assigned": 0, "reassigned": 0 }, "vpcs": { "assigned": 0, "reassigned": 0 }, "vpns": { "assigned": 0, "reassigned": 0 }, "networkConnections": { "assigned": 0, "reassigned": 0 }, "workerLoggingOverride": { "enabled": false }, "messaging": { "assigned": 0 }, "mqMessages": { "base": 0, "addOn": 0 }, "mqRequests": { "base": 0, "addOn": 0 }, "mqAdvancedFeatures": { "enabled": false }, "objectStoreRequestUnits": { "base": 0, "addOn": 0 }, "objectStoreKeys": { "base": 0, "addOn": 0 }, "gateways": { "assigned": 0 }, "designCenter": { "mozart": true, "api": true, "apiVisual": false, "apiExample": false }, "partnersProduction": { "assigned": 0 }, "partnersSandbox": { "assigned": 0 }, "tradingPartnersProduction": { "assigned": 0 }, "tradingPartnersSandbox": { "assigned": 0 }, "loadBalancer": { "assigned": 1, "reassigned": 0 }, "externalIdentity": true, "autoscaling": false, "armAlerts": false, "apis": { "enabled": true }, "apiCatalog": { "enabled": false }, "apiMonitoring": { "schedules": 0 }, "apiCommunityManager": { "enabled": false }, "apiExperienceHub": { "enabled": false }, "monitoringCenter": { "productSKU": 3, "rawStorageOverrideGB": 0, "dataRegion": "us-east-1", "productionUnits": 0, "preProductionUnits": 0, "storageBase": 0, "storageAddOn": 0 }, "apiQuery": { "enabled": false, "productSKU": 1 }, "apiQueryC360": { "enabled": false }, "rpa": { "enabled": false, "active": false, "composerVersion": "" }, "idp": { "enabled": false }, "AutomationCreditsDW": { "assigned": 0 }, "apiGovernance": { "enabled": true, "apisPerMonth": 5 }, "apiGovernanceDomain": { "domain": "ASSET" }, "crowd": { "hideApiManagerDesigner": false, "hideFormerApiPlatform": false, "environments": false }, "cam": { "enabled": false }, "exchange2": { "enabled": false, "assetUsageAndEngagement": { "enabled": false } }, "crowdSelfServiceMigration": { "enabled": false }, "kpiDashboard": { "enabled": false }, "pcf": false, "appViz": false, "workerClouds": { "assigned": 0, "reassigned": 0 }, "runtimeFabric": false, "runtimeFabricCloud": { "enabled": false }, "serviceMesh": { "enabled": false }, "flexGateway": { "enabled": false }, "managedGatewaySmall": { "assigned": 0, "reassigned": 0 }, "managedGatewayLarge": { "assigned": 0, "reassigned": 0 }, "rtfManagedGateway": { "enabled": false }, "composer": { "enabled": false, "tasksPerMonth": 100, "maxConnectors": 3, "unlimitedConnectors": false, "isHyperAutomation": false }, "muleDxWebIde": { "enabled": false }, "muleDxGenAI": { "enabled": false }, "muleDxEDA": { "enabled": false }, "cloudhub1": { "enabled": true }, "telemetryExporter": { "enabled": true } }, "tenantOrganizationIds": [], "isRoot": true, "isMaster": true, "sessionTimeout": 60, "properties": { "defaultAccessManagementUi": "cs-ui" }, "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" } }

Delete Organizations deleteOrganizations

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes the referenced organization

Path Parameters

organizationId *: string

Response

Success

List Client Providers listClientProviders

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns list of client management providers for the root organization with a subset of values (providerId, organizationId, name, type (name, description, version))

Path Parameters

organizationId *: string

Query Parameters

provider_id: array
One or more ids of the provider(s) to return.
offset: integer
ascending *: boolean
cp_type: array
One or more types of provider(s) to return.
sort: string
limit: integer
search: string
A search string to use for case-insensitive partial matches on name

Response

json
Success
data *: array
total *: number
Examples
application/json
{ "data": [ { "providerId": "2e50e859-0042-46ff-8cf8-1ad6f0c78b67", "organizationId": "2e71d283-6248-4c81-98eb-e254a89b7e0a", "name": "Production Client Management Config", "type": { "description": "PingFederate", "name": "ping" } } ], "total": 1 }

Create Client Providers createClientProviders

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Adds a new client management provider for the organization. This can be called only on Root Organizations

Path Parameters

organizationId *: string

Request Body

json

Response

Success

Get Client Providers getClientProviders

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns the associated client management provider config for the root organization and a subset of values (providerId, organizationId, name, type (name, description, version)) for Business Groups

Path Parameters

organizationId *: string
clientProviderId *: string

Query Parameters

includeSecrets *: boolean

Response

Success

Update Client Providers updateClientProviders

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Replaces the associated client management provider config

Path Parameters

organizationId *: string
clientProviderId *: string

Request Body

json

Response

Success

Update Organization Client Provider updateOrganizationClientProvider

PATCH

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the associated client management provider config

Path Parameters

organizationId *: string
clientProviderId *: string

Query Parameters

recreateTokenValidationClient *: boolean

Request Body

json

Response

Success

Delete Client Providers deleteClientProviders

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes the associated client management provider

Path Parameters

organizationId *: string
clientProviderId *: string

Response

Success

List Client Providers Grant Types listClientProvidersGrantTypes

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns the associated client management provider type and grant types it suppports.

Path Parameters

organizationId *: string
clientProviderId *: string

Response

json
Success
type *: object
grant_types *: array

List Client Providers Clients listClientProvidersClients

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns the clients created using this specific Client Management Provider

Path Parameters

organizationId *: string
clientProviderId *: string

Query Parameters

client_id: array
One or more ids of the client(s) to return.
offset: integer
ascending *: boolean
sort: string
limit: integer
search: string
A search string to use for case-insensitive partial matches on client_name

Response

json
Sucess
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "client_id": "8c45c1f1-d35b-42ed-b497-8c4af9e18c4e", "client_name": "SampleClient", "client_secret": "test-client-secret", "grant_types": [ "implicit" ], "redirect_uris": [ "https://localhost:3000/callback", "https://example.com/auth-callback" ], "org_id": "693ceb1a-c801-4b31-a491-8f194a624165", "client_management_provider_id": "ff62313fc59845beaba2ffa79da1abc8" } ], "total": 1 }

Create Client Providers Clients createClientProvidersClients

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Adds a new client using the Client Management Provider

Path Parameters

organizationId *: string
clientProviderId *: string

Request Body

json
client_name: string
client_id: string
client_secret: string
grant_types: array
redirect_uris: array

Response

Success

Get Client Providers Clients getClientProvidersClients

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns the associated clients info

Path Parameters

organizationId *: string
clientProviderId *: string
clientId *: string

Response

json
Success
client_id *: string
The unique identifier of the client application.
client_name *: string
The display name of the client application.
client_secret *: string
The client secret used to authenticate the application when requesting tokens.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
org_id *: string
The unique identifier of the organization.
client_management_provider_id *: string
The unique identifier of the client management identity provider associated with the resource.
Examples
application/json
{ "client_id": "8c45c1f1-d35b-42ed-b497-8c4af9e18c4e", "client_name": "SampleClient", "client_secret": "test-client-secret", "grant_types": [ "implicit", "authorization_code" ], "redirect_uris": [ "https://localhost:3000/callback", "https://example.com/auth-callback" ], "org_id": "693ceb1a-c801-4b31-a491-8f194a624165", "client_management_provider_id": "ff62313fc59845beaba2ffa79da1abc8" }

Update Client Providers Clients updateClientProvidersClients

PATCH

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the associated client

Path Parameters

organizationId *: string
clientProviderId *: string
clientId *: string

Query Parameters

force: string
If true, client is going to be updated in Anypoint no matter if it's updated from the external client provider.
resetSecret: boolean

Request Body

json
client_name: string
client_id: string
client_secret: string
grant_types: array
redirect_uris: array

Response

Success

Delete Client Providers Clients deleteClientProvidersClients

DELETE

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Deletes the associated client

Path Parameters

organizationId *: string
clientProviderId *: string
clientId *: string

Query Parameters

force: string
If true, client is going to be deleted from Anypoint no matter if it's deleted from the external client provider.

Response

Success

List Organization Clients listOrganizationClients

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get all clients

Path Parameters

organizationId *: string

Response

json
ac_client *: object
The client used by the platform to perform authorization-code flows.
rs_client *: object
The client used by the platform to perform resource-server operations.
ro_client *: object
The client used by the platform to perform resource-owner operations.
cc_client *: object
The client used by the platform to perform client-credentials flows.
im_client *: object
The client used by the platform to integrate with the identity manager.
cp_client *: object
The client used by the platform to communicate with the control plane.
Examples
application/json
{ "ac_client": { "client_id": "ac_client", "name": "Authorization Code", "redirect_uris": [ "http://localhost:3004/auth/callback" ], "grant_types": [ "authorization_code", "refresh_token" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, "rs_client": { "client_id": "rs_client", "name": "Resource Server", "grant_types": [ "validate_bearer" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, "ro_client": { "client_id": "ro_client", "name": "Resource Owner", "grant_types": [ "password", "refresh_token" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, "cc_client": { "client_id": "cc_client", "name": "Client Credentials", "grant_types": [ "client_credentials" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, "im_client": { "client_id": "im_client", "name": "Implicit", "redirect_uris": [ "http://localhost:3004/auth/callback" ], "grant_types": [ "implicit", "validate_bearer" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, "cp_client": { "client_id": "cp_client", "name": "Client Credentials", "redirect_uris": [ "http://localhost:3004/auth/callback" ], "grant_types": [ "client_credentials" ], "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb", "client_management_provider_id": "b732985a-d30f-11e9-bb65-2a2ae2dbcce4" } }

Create Organization Client createOrganizationClient

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a new client

Path Parameters

organizationId *: string

Request Body

json
client_id *: string
The unique identifier of the client application.
client_secret *: string
The client secret used to authenticate the application when requesting tokens.
name *: string
The display name of the resource.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
properties *: object
Additional properties associated with the resource.
org_id *: string
The unique identifier of the organization.
Examples
application/json
{ "client_id": "im_client", "client_secret": "changeme", "name": "Implicit", "redirect_uris": [ "http://localhost/callback" ], "grant_types": [ "implicit" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }

Response

json
client_id *: string
The unique identifier of the client application.
name *: string
The display name of the resource.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
properties *: object
Additional properties associated with the resource.
org_id *: string
The unique identifier of the organization.
Examples
application/json
{ "client_id": "im_client", "name": "Implicit", "redirect_uris": [ "http://localhost/callback" ], "grant_types": [ "implicit" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }

Get Organization Client getOrganizationClient

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get a single client

Path Parameters

organizationId *: string
clientId *: string

Response

json
client_id *: string
The unique identifier of the client application.
name *: string
The display name of the resource.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
properties *: object
Additional properties associated with the resource.
org_id *: string
The unique identifier of the organization.
Examples
application/json
{ "client_id": "im_client", "name": "Implicit", "redirect_uris": [ "http://localhost/callback" ], "grant_types": [ "implicit" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }

Update Organization Client updateOrganizationClient

PATCH

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single client

Path Parameters

organizationId *: string
clientId *: string

Query Parameters

resetSecret *: boolean
Asks service to reset secret as part of this operation

Request Body

json
client_id *: string
The unique identifier of the client application.
name *: string
The display name of the resource.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
properties *: object
Additional properties associated with the resource.
org_id *: string
The unique identifier of the organization.
Examples
application/json
{ "client_id": "im_client", "name": "Implicit", "redirect_uris": [ "http://localhost/callback" ], "grant_types": [ "implicit" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }

Response

Delete Organization Client deleteOrganizationClient

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes a single client

Path Parameters

organizationId *: string
clientId *: string

Response

Create Organization Client Role createOrganizationClientRole

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Assign a list of roles to a client

Path Parameters

organizationId *: string
clientId *: string

Request Body

json
20460a62-bbdc-469d-9330-5eec892abd05 *: object
Per-resource entry keyed by identifier.
20460a62-bbdc-469d-9660-5eec892abd05 *: object
Per-resource entry keyed by identifier.
Examples
application/json
{ "20460a62-bbdc-469d-9330-5eec892abd05": { "org": "ms", "env": "test" }, "20460a62-bbdc-469d-9660-5eec892abd05": { "org": "ms", "env": "dev" } }

Response

Delete Organization Client Roles deleteOrganizationClientRoles

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Unassign a list of roles from a client

Path Parameters

organizationId *: string
clientId *: string

Request Body

json
20460a62-bbdc-469d-9330-5eec892abd05 *: object
Per-resource entry keyed by identifier.
20460a62-bbdc-469d-9660-5eec892abd05 *: object
Per-resource entry keyed by identifier.
Examples
application/json
{ "20460a62-bbdc-469d-9330-5eec892abd05": { "org": "ms", "env": "test" }, "20460a62-bbdc-469d-9660-5eec892abd05": { "org": "ms", "env": "dev" } }

Response

Create Organization Client Role By Id createOrganizationClientRoleById

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Assign a role to a client

Path Parameters

organizationId *: string
clientId *: string
roleId *: string
The unique identifier of the role.

Request Body

json
org *: string
The organization slug or short identifier used in API paths.
env *: string
The environment slug or short identifier used in API paths.
Examples
application/json
{ "org": "ms", "env": "test" }

Response

Delete Organization Client Role deleteOrganizationClientRole

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Unassign a role from a client

Path Parameters

organizationId *: string
clientId *: string
roleId *: string
The unique identifier of the role.

Response

Create Organization Clients Search createOrganizationClientsSearch

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Search clients

Path Parameters

organizationId *: string

Request Body

json
name: string
client_id: array
client_management_provider_id: array

Response

json
Success
items: array
Response payload for createOrganizationClientsSearch.
Examples
application/json
[ { "client_id": "ac_client", "name": "Authorization Code", "redirect_uris": [ "http://localhost:3004/auth/callback" ], "grant_types": [ "authorization_code", "refresh_token" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, { "client_id": "rs_client", "name": "Resource Server", "grant_types": [ "validate_bearer" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, { "client_id": "ro_client", "name": "Resource Owner", "grant_types": [ "password", "refresh_token" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, { "client_id": "cc_client", "name": "Client Credentials", "grant_types": [ "client_credentials" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, { "client_id": "im_client", "name": "Implicit", "redirect_uris": [ "http://localhost:3004/auth/callback" ], "grant_types": [ "implicit", "validate_bearer" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }, { "client_id": "cp_client", "name": "Client Credentials", "redirect_uris": [ "http://localhost:3004/auth/callback" ], "grant_types": [ "client_credentials" ], "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb", "client_management_provider_id": "b732985a-d30f-11e9-bb65-2a2ae2dbcce4" } ]

Create Clients Validate createClientsValidate

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Validate clients

Path Parameters

organizationId *: string

Request Body

json
client_id *: string
client_secret: string

Response

json
Success
client_id *: string
The unique identifier of the client application.
name *: string
The display name of the resource.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
properties *: object
Additional properties associated with the resource.
org_id *: string
The unique identifier of the organization.
Examples
application/json
{ "client_id": "im_client", "name": "Implicit", "redirect_uris": [ "http://localhost/callback" ], "grant_types": [ "implicit" ], "properties": { "additional": "meta-data" }, "org_id": "40260a62-bbdc-469d-9330-5eec892abbbb" }

List Organization Connected Applications listOrganizationConnectedApplications

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get all connected applications for the organization

Path Parameters

organizationId *: string

Query Parameters

includeUsage *: boolean
hide_managed: boolean
organizationId: string
offset: integer
ascending *: boolean
sort: string
limit: integer
search: string
A search string to use for case-insensitive partial matches on all object properties

Response

json
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "client_id": "0fa2aa2f0aeb4978b96796a0843f898c", "owner_org_id": "0eb65884-4f75-48f7-a8bc-4e30b46e721d", "client_name": "Client Credz", "client_secret": "B0313ad5a6B44f7ebb4Bf482C49327e1", "public_keys": [], "redirect_uris": [ "https://why.net" ], "grant_types": [ "client_credentials" ], "scopes": [], "enabled": true, "audience": "internal", "client_uri": null, "policy_uri": null, "tos_uri": null, "generate_iss_claim_without_token": true }, { "client_id": "e8c28f0249a6417bb892ff8d6013d628", "owner_org_id": "0eb65884-4f75-48f7-a8bc-4e30b46e721d", "client_name": "OpenID Integration", "client_secret": "eA0Fa9BaAe454F32A6Ae8ABBc1b730C0", "public_keys": [], "redirect_uris": [ "https://example.com" ], "grant_types": [ "implicit", "authorization_code", "refresh_token" ], "scopes": [ "full", "read:full", "openid", "profile", "email", "offline_access" ], "enabled": true, "audience": "internal", "client_uri": null, "policy_uri": null, "tos_uri": null, "generate_iss_claim_without_token": false } ], "total": 2 }

Create Organization Connected Application createOrganizationConnectedApplication

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a new connected application

Path Parameters

organizationId *: string

Request Body

json
grant_types: array
The grant types to be used with this app
client_name: string
enabled: boolean
owner_user_id: string
generate_iss_claim_without_token: boolean
public_keys: array
client_secret: string
client_id: string
tos_uri: string
scopes: array
The level of permissions to provide to the app
client_uri: string
redirect_uris *: array
Configure which URIs users should be directed to after authorization
owner_org_id: string
audience: string
Configure whether the app is internal to your company or is a third-party public app that can be distributed outside of your organization
policy_uri: string

Response

json
client_id *: string
The unique identifier of the client application.
owner_org_id *: string
The unique identifier of the organization that owns the resource.
client_name *: string
The display name of the client application.
client_secret *: string
The client secret used to authenticate the application when requesting tokens.
public_keys *: array
The public keys used to verify signatures issued by the resource.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
scopes *: array
The OAuth 2.0 scopes granted to the resource.
enabled *: boolean
Whether the feature or resource is currently enabled.
audience *: string
The audience (intended recipient) of the issued token, as defined by the OAuth 2.0 specification.
generate_iss_claim_without_token *: boolean
Whether the issuer claim should be generated when no access token is present.
Examples
application/json
{ "client_id": "0fa2aa2f0aeb4978b96796a0843f898c", "owner_org_id": "0eb65884-4f75-48f7-a8bc-4e30b46e721d", "client_name": "SampleClient", "client_secret": "B0313ad5a6B44f7ebb4Bf482C49327e1", "public_keys": [], "redirect_uris": [ "https://why.net" ], "grant_types": [ "client_credentials" ], "scopes": [], "enabled": true, "audience": "internal", "generate_iss_claim_without_token": true }

Get Organization Connected Application getOrganizationConnectedApplication

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get a single connected application

Path Parameters

organizationId *: string
clientId *: string

Query Parameters

includeUsage *: boolean

Response

json
client_id *: string
The unique identifier of the client application.
owner_org_id *: string
The unique identifier of the organization that owns the resource.
client_name *: string
The display name of the client application.
client_secret *: string
The client secret used to authenticate the application when requesting tokens.
public_keys *: array
The public keys used to verify signatures issued by the resource.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
scopes *: array
The OAuth 2.0 scopes granted to the resource.
enabled *: boolean
Whether the feature or resource is currently enabled.
audience *: string
The audience (intended recipient) of the issued token, as defined by the OAuth 2.0 specification.
generate_iss_claim_without_token *: boolean
Whether the issuer claim should be generated when no access token is present.
Examples
application/json
{ "client_id": "0fa2aa2f0aeb4978b96796a0843f898c", "owner_org_id": "0eb65884-4f75-48f7-a8bc-4e30b46e721d", "client_name": "SampleClient", "client_secret": "B0313ad5a6B44f7ebb4Bf482C49327e1", "public_keys": [], "redirect_uris": [ "https://why.net" ], "grant_types": [ "client_credentials" ], "scopes": [], "enabled": true, "audience": "internal", "generate_iss_claim_without_token": true }

Update Organization Connected Application updateOrganizationConnectedApplication

PATCH

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single connected application

Path Parameters

organizationId *: string
clientId *: string

Query Parameters

resetSecret: boolean

Request Body

json
client_id: string
client_name: string
client_secret: string
owner_org_id: string
owner_user_id: string
enabled: boolean
audience: string
Configure whether the app is internal to your company or is a third-party public app that can be distributed outside of your organization
client_uri: string
policy_uri: string
tos_uri: string
public_keys: array
grant_types: array
The grant types to be used with this app
redirect_uris: array
Configure which URIs users should be directed to after authorization
scopes: array
The level of permissions to provide to the app
generate_iss_claim_without_token: boolean

Response

json
Connected Application was successfully updated
client_id *: string
The unique identifier of the client application.
owner_org_id *: string
The unique identifier of the organization that owns the resource.
client_name *: string
The display name of the client application.
client_secret *: string
The client secret used to authenticate the application when requesting tokens.
public_keys *: array
The public keys used to verify signatures issued by the resource.
redirect_uris *: array
The redirect URIs the user is sent to after authorization completes.
grant_types *: array
The OAuth 2.0 grant types supported by the application.
scopes *: array
The OAuth 2.0 scopes granted to the resource.
enabled *: boolean
Whether the feature or resource is currently enabled.
audience *: string
The audience (intended recipient) of the issued token, as defined by the OAuth 2.0 specification.
generate_iss_claim_without_token *: boolean
Whether the issuer claim should be generated when no access token is present.
Examples
application/json
{ "client_id": "0fa2aa2f0aeb4978b96796a0843f898c", "owner_org_id": "0eb65884-4f75-48f7-a8bc-4e30b46e721d", "client_name": "SampleClient", "client_secret": "B0313ad5a6B44f7ebb4Bf482C49327e1", "public_keys": [], "redirect_uris": [ "https://why.net" ], "grant_types": [ "client_credentials" ], "scopes": [], "enabled": true, "audience": "internal", "generate_iss_claim_without_token": true }

Delete Organization Connected Application deleteOrganizationConnectedApplication

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes a single connected application

Path Parameters

organizationId *: string
clientId *: string

Response

Connected application was deleted

List Organization Connected Application Scopes listOrganizationConnectedApplicationScopes

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves context-aware scopes assigned to the connected application

Path Parameters

organizationId *: string
clientId *: string

Query Parameters

offset: integer
limit: integer

Response

json
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "scope": "example:scope", "context_params": { "org": "8b0b657c-91ca-420d-870a-08699094f5e4", "envId": "7cc0463b-f7be-418d-8a64-84fbad13ab00" } } ], "total": 1 }

Update Organization Connected Application Scopes updateOrganizationConnectedApplicationScopes

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Replaces the entire list of context-aware scopes assigned to the connected application

Path Parameters

organizationId *: string
clientId *: string

Request Body

json
scopes *: array
Examples
application/json
{ "scopes": [ { "scope": "example:scope", "context_params": { "org": "8b0b657c-91ca-420d-870a-08699094f5e4", "envId": "7cc0463b-f7be-418d-8a64-84fbad13ab00" } } ] }

Response

Connected application scopes were successfully replaced

Replace Organization Connected Application Scopes replaceOrganizationConnectedApplicationScopes

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Assigns additional context-aware scopes to the connected application.
Does not unassign any existing scopes.
Duplicate entries are ignored.

Path Parameters

organizationId *: string
clientId *: string

Request Body

json
scopes *: array
scopesToDelete: array
Examples
application/json
{ "scopes": [ { "scope": "example:scope1", "context_params": { "org": "8b0b657c-91ca-420d-870a-08699094f5e4", "envId": "7cc0463b-f7be-418d-8a64-84fbad13ab00" } } ], "scopesToDelete": [ { "scope": "example:scope2", "context_params": { "org": "8b0b657c-91ca-420d-870a-08699094f5e4", "envId": "7cc0463b-f7be-418d-8a64-84fbad13ab00" } } ] }

Response

Connected application scopes were successfully assigned

Delete Organization Connected Application Scopes deleteOrganizationConnectedApplicationScopes

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Unassigns context-aware scopes from the connected application.
Scopes must exactly match in order to be removed.

Path Parameters

organizationId *: string
clientId *: string

Request Body

json
scopes *: array
Examples
application/json
{ "scopes": [ { "scope": "example:scope", "context_params": { "org": "8b0b657c-91ca-420d-870a-08699094f5e4", "envId": "7cc0463b-f7be-418d-8a64-84fbad13ab00" } } ] }

Response

Connected application scopes were successfully unassigned

Revoke Organization Connected Application revokeOrganizationConnectedApplication

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Revoke all access tokens and refresh tokens issued to the connected application

Path Parameters

organizationId *: string
clientId *: string

Response

All tokens were revoked successfully

List Connected Applications Authorizations listConnectedApplicationsAuthorizations

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns all the authorizations that grant access to resources in the organization.

Path Parameters

organizationId *: string

Query Parameters

user_id: string
Only return authorizations granted by that user
offset: integer
limit: integer

Response

json
Success
data *: array
total *: number
Examples
application/json
{ "data": [ { "authorization_id": "456", "created_at": "2018-01-26T22:39:02.312000+00:00", "updated_at": "2018-01-26T22:39:02.312000+00:00", "last_used": "2018-01-26T22:39:02.312000+00:00", "user_id": "b65f412f-7d36-4109-b196-9d5ad07c2083", "client_id": "d5e32198-7cc1-4c26-ab83-fd8912e16967", "as_id": "anypoint", "scopes": [ "read:raml", "read:users", "offline_access" ] } ], "total": 1 }

Delete Connected Applications Authorizations deleteConnectedApplicationsAuthorizations

DELETE

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Revoke all authorizations that grant rights to accessing resources in the business group. Only available on the root organization.

Path Parameters

organizationId *: string

Query Parameters

user_id *: string
Only delete authorizations granted by that user

Response

Success

Get Connected Applications Authorizations getConnectedApplicationsAuthorizations

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a single authorization

Path Parameters

organizationId *: string
authorizationId *: string
The ID of the authorization

Response

json
Success
authorization_id *: string
The ID of the authorization object
created_at *: string(date-time)
The time the authorization was created
updated_at *: string(date-time)
The time the authorization was last modified
last_used *: string(date-time)
The time the authorization was last used in an OAuth2 flow
user_id *: string
client_id *: string
scopes *: array
The list of OAuth2 scopes contained in the authorization

Delete Organization Connected Application Authorization deleteOrganizationConnectedApplicationAuthorization

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Revokes an authorization. Only available on the root organization.

Path Parameters

organizationId *: string
authorizationId *: string
The ID of the authorization

Response

Success

List Connected Applications Settings listConnectedApplicationsSettings

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns the organization's Connected Application settings. For business groups, this will return the root organization's settings.

Path Parameters

organizationId *: string

Response

json
Success
whitelist_enabled: boolean
allowlist_enabled: boolean
applications_enabled *: string
grant_types_allowed *: array
The list of all grant types the Organization allows clients to use
whitelist_internal_applications: boolean
allowlist_internal_applications: boolean

Update Connected Applications Settings updateConnectedApplicationsSettings

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the organization's connected application settings

Path Parameters

organizationId *: string

Request Body

json
grant_types_allowed *: array
The list of all grant types the Organization allows clients to use
whitelist_enabled: boolean
whitelist: array
A set of entries to upsert into to the allowlist.
import_existing_authorizations: boolean
If true, add all existing client authorizations to the allowlist with their registered scopes
whitelist_internal_applications: boolean
allowlist_internal_applications: boolean
allowlist_enabled: boolean
applications_enabled *: string

Response

json
Success
whitelist_enabled: boolean
allowlist_enabled: boolean
applications_enabled *: string
grant_types_allowed *: array
The list of all grant types the Organization allows clients to use
whitelist_internal_applications: boolean
allowlist_internal_applications: boolean

List Connected Applications Allowlist listConnectedApplicationsAllowlist

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns the entries on the organization's Connected Application allowlist

Path Parameters

organizationId *: string

Query Parameters

client_id: array
search for allowlist entries by specific client_id
offset: integer
limit: integer

Response

json
Success
data *: array
total *: number
Examples
application/json
{ "data": [ { "client_id": "cba8d24f-8e6b-4615-9bb8-bc5a2c9933cd", "authorized_scopes": [ "openid", "offline_access", "read:organization" ] } ], "total": 1 }

Update Connected Applications Allowlist updateConnectedApplicationsAllowlist

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Replaces the organization's Connected Application allowlist with a new one

Path Parameters

organizationId *: string

Request Body

json
items: array
Array items

Response

Success

Update Organization Connected Applications Allowlist updateOrganizationConnectedApplicationsAllowlist

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Inserts the entries into the organization's Connected Application allowlist

Path Parameters

organizationId *: string

Request Body

json
items: array
Array items

Response

Success

Delete Connected Applications Allowlist deleteConnectedApplicationsAllowlist

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Deletes the entries from the organization's Connected Application allowlist

Path Parameters

organizationId *: string

Request Body

json
items: array
Array items

Response

Success

List Connected Applications Whitelist listConnectedApplicationsWhitelist

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns the entries on the organization's Connected Application allowlist

Path Parameters

organizationId *: string

Query Parameters

client_id: array
search for allowlist entries by specific client_id
offset: integer
limit: integer

Response

json
Success
data *: array
total *: number
Examples
application/json
{ "data": [ { "client_id": "cba8d24f-8e6b-4615-9bb8-bc5a2c9933cd", "authorized_scopes": [ "openid", "offline_access", "read:organization" ] } ], "total": 1 }

Update Connected Applications Whitelist updateConnectedApplicationsWhitelist

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Replaces the organization's Connected Application allowlist with a new one

Path Parameters

organizationId *: string

Request Body

json
items: array
Array items

Response

Success

Update Organization Connected Applications Whitelist updateOrganizationConnectedApplicationsWhitelist

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Inserts the entries into the organization's Connected Application allowlist

Path Parameters

organizationId *: string

Request Body

json
items: array
Array items

Response

Success

Delete Connected Applications Whitelist deleteConnectedApplicationsWhitelist

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Deletes the entries from the organization's Connected Application allowlist

Path Parameters

organizationId *: string

Request Body

json
items: array
Array items

Response

Success

List Entitlements listEntitlements

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns the entitlements for the organization

Path Parameters

organizationId *: string

Response

Success

Get Entitlements getEntitlements

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get an entitlement by name

Path Parameters

organizationId *: string
entitlementName *: string
The name of an entitlement

Response

Success

Update Entitlements updateEntitlements

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update an entitlement.
Note: Connected apps cannot perform this action and is reserved only for org admins.

Path Parameters

organizationId *: string
entitlementName *: string
The name of an entitlement

Request Body

json
value *: object
A single value returned by the request.
Examples
application/json
{ "values": "{\"enabled\":false}" }

Response

Success

List Environments listEnvironments

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns all matching environments

Path Parameters

organizationId *: string

Query Parameters

name: string
Case sensitive match on the environment name
isProduction: boolean
Whether returns only production or non-production environments
expandAll: string
Returns all environments within the rootOrg that caller has access to. If this is true, orgId has to be a valid rootOrgId.
offset: integer
type: string
The type of environment - production, sandbox, or/or design
limit: integer
search: string
A search string to use for case-insensitive partial matches on environment names

Response

json
Returns environments
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "70b3f7cb-614c-4276-b0cd-4f73db11602c", "name": "Development", "isProduction": true, "type": "production", "clientId": "abdf31490ba44484a1de789baf685e37" } ], "total": 1 }

Create Environments createEnvironments

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates an environment

Path Parameters

organizationId *: string

Request Body

json
name *: string
The display name of the resource.
isProduction *: boolean
Whether the environment is a production environment.
type *: string
The type of the resource.
Examples
application/json
{ "name": "Development", "isProduction": false, "type": "sandbox" }

Response

json
Environment created. Returns the newly created environment
id *: string
The unique identifier of the resource.
organizationId *: string
The unique identifier of the organization.
name *: string
The display name of the resource.
isProduction *: boolean
Whether the environment is a production environment.
type *: string
The type of the resource.
clientId *: string
The unique identifier of the client application.
Examples
application/json
{ "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "70b3f7cb-614c-4276-b0cd-4f73db11602c", "name": "Development", "isProduction": false, "type": "sandbox", "clientId": "abdf31490ba44484a1de789baf685e37" }

Get Organization Environment getOrganizationEnvironment

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves an environment by id

Path Parameters

organizationId *: string
environmentId *: string

Response

json
Returns the environment
id *: string
The unique identifier of the resource.
organizationId *: string
The unique identifier of the organization.
name *: string
The display name of the resource.
isProduction *: boolean
Whether the environment is a production environment.
type *: string
The type of the resource.
clientId *: string
The unique identifier of the client application.
Examples
application/json
{ "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "70b3f7cb-614c-4276-b0cd-4f73db11602c", "name": "Development", "isProduction": false, "type": "sandbox", "clientId": "abdf31490ba44484a1de789baf685e37" }

Update Organization Environment updateOrganizationEnvironment

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update an environment, implemented as a patch. Note that only the name is allowed to be updated, isProduction and type can not.

Path Parameters

organizationId *: string
environmentId *: string

Request Body

json
name *: string
The display name of the resource.
Examples
application/json
{ "name": "CoolEnvironmentsAround" }

Response

json
Returns the updated environment
id *: string
The unique identifier of the resource.
organizationId *: string
The unique identifier of the organization.
name *: string
The display name of the resource.
isProduction *: boolean
Whether the environment is a production environment.
type *: string
The type of the resource.
clientId *: string
The unique identifier of the client application.
Examples
application/json
{ "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "70b3f7cb-614c-4276-b0cd-4f73db11602c", "name": "Development", "isProduction": false, "type": "sandbox", "clientId": "abdf31490ba44484a1de789baf685e37" }

Delete Environments deleteEnvironments

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete an environment

Path Parameters

organizationId *: string
environmentId *: string

Response

Successful. Returns zero length body

List Environments Client Management Providers listEnvironmentsClientManagementProviders

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves client management providers for the environment

Path Parameters

organizationId *: string
environmentId *: string

Response

json
returns client management providerIds for the environment
suggestedClientManagementProviderIds *: array
Identifiers of the client management identity providers suggested for use with this organization.
Examples
application/json
{ "suggestedClientManagementProviderIds": [ "6a57bf06-9124-11e9-bc42-526af7764f64" ] }

Update Environments Client Management Providers updateEnvironmentsClientManagementProviders

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Upsert client providers for the environment

Path Parameters

organizationId *: string
environmentId *: string

Request Body

json
suggestedClientManagementProviderIds *: array

Response

json
returns client management providerIds for the environment
suggestedClientManagementProviderIds *: array
Identifiers of the client management identity providers suggested for use with this organization.
Examples
application/json
{ "suggestedClientManagementProviderIds": [ "6a57bf06-9124-11e9-bc42-526af7764f64" ] }

List Feature Flags listFeatureFlags

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
get all feature flags of an given organization

Path Parameters

organizationId *: string

Query Parameters

offset: integer
limit: integer

Response

Bad parameter or other failure

Get Feature Flags getFeatureFlags

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
API to get a feature flag for a given org.

Path Parameters

organizationId *: string
featureFlagName *: string
The name of the feature flag to evaluate.

Response

Too many requests

Create Feature Flags createFeatureFlags

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
API to upsert a feature flag.

Path Parameters

organizationId *: string
featureFlagName *: string
The name of the feature flag to evaluate.

Request Body

json
context: object
enabled *: boolean

Response

Success

List Hierarchy listHierarchy

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
get Business Groups (down to the leaves) of this organization.

Path Parameters

organizationId *: string

Response

json
Success
name *: string
The display name of the resource.
id *: string
The unique identifier of the resource.
createdAt *: string
The date and time when the resource was created, in ISO 8601 format.
updatedAt *: string
The date and time when the resource was last updated, in ISO 8601 format.
ownerId *: string
The unique identifier of the user who owns the resource.
clientId *: string
The unique identifier of the client application.
domain *: string
The domain name associated with the organization.
idprovider_id *: string
The unique identifier of the identity provider.
isFederated *: boolean
Whether the organization uses a federated identity provider for authentication.
parentOrganizationIds *: array
Identifiers of the organizations that are ancestors of this organization in the hierarchy.
subOrganizationIds *: array
Identifiers of the organizations that are direct children of this organization.
tenantOrganizationIds *: array
Identifiers of the tenant organizations associated with this organization.
isRoot *: boolean
Whether the organization is the root organization in the hierarchy.
isMaster *: boolean
Whether the organization is the master organization.
properties *: object
Additional properties associated with the resource.
environmentsCount *: integer
The number of environments configured for the organization.
owner *: object
The user or entity that owns the resource.
subOrganizations *: array
The organizations that are direct children of this organization.
Examples
application/json
{ "name": "MuleSoft Inc", "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "createdAt": "2015-03-13T18:03:23.869000+00:00", "updatedAt": "2015-03-13T18:03:24.207000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "clientId": "b63237d9c5d444ea95147065e0711161", "domain": "mulesoft-inc", "idprovider_id": "mulesoft", "isFederated": false, "parentOrganizationIds": [], "subOrganizationIds": [ "bec472ed-dbeb-48b5-b978-0984394673a6", "0d12b66b-ee6a-4d66-b36c-6aeee637cde2", "07fd6c5b-0036-48a3-b2af-3194c06bed6c" ], "tenantOrganizationIds": [], "isRoot": true, "isMaster": true, "properties": { "defaultAccessManagementUi": "cs-ui" }, "environmentsCount": 2, "owner": { "id": "57e281b5-ec5b-4701-80a0-92a936a68da3", "username": "organization_owner", "firstName": "Organization", "lastName": "Owner", "email": "api.platform.qa+o_o@gmail.com", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "enabled": true, "idprovider_id": "mulesoft" }, "subOrganizations": [ { "name": "Sales", "id": "07fd6c5b-0036-48a3-b2af-3194c06bed6c", "createdAt": "2015-03-13T18:03:28.663000+00:00", "updatedAt": "2015-03-13T18:03:28.669000+00:00", "ownerId": "e3c4c70d-bf11-4f64-8cc6-b75b5d2200a6", "clientId": "696e3d7104f6456fa06f21a9e05d9067", "domain": "sales", "idprovider_id": "mulesoft", "isFederated": false, "parentOrganizationIds": [ "f0c9b011-980e-4928-9430-e60e3a97c043" ], "subOrganizationIds": [], "tenantOrganizationIds": [], "isRoot": true, "isMaster": false, "subOrganizations": [], "environmentsCount": 2, "owner": { "id": "e3c4c70d-bf11-4f64-8cc6-b75b5d2200a6", "username": "sales_director", "firstName": "Sales", "lastName": "Director", "email": "api.platform.qa+sales_director@gmail.com", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "enabled": true, "idprovider_id": "mulesoft" } }, { "name": "Engineering", "id": "bec472ed-dbeb-48b5-b978-0984394673a6", "createdAt": "2015-03-13T18:03:28.356000+00:00", "updatedAt": "2015-03-13T18:03:28.363000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "clientId": "33b046c20d4f448fad768af6394ce341", "domain": "engineering", "idprovider_id": "mulesoft", "isFederated": false, "parentOrganizationIds": [ "f0c9b011-980e-4928-9430-e60e3a97c043" ], "subOrganizationIds": [ "4b1240fd-e1df-44a8-9949-6778c3d3dd91", "bea09f72-33ce-43ce-82fe-32f9f0bd49ea", "d156efa0-04c3-41fa-a2d3-e0b428d2cb4e" ], "tenantOrganizationIds": [], "isRoot": true, "isMaster": false, "environmentsCount": 2, "subOrganizations": [ { "name": "API Platform", "id": "4b1240fd-e1df-44a8-9949-6778c3d3dd91", "createdAt": "2015-03-13T18:03:28.407000+00:00", "updatedAt": "2015-03-13T18:03:28.415000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "clientId": "74a2b53b218c410aba751e40bbd6995e", "domain": "api-platform", "idprovider_id": "mulesoft", "isFederated": false, "parentOrganizationIds": [ "f0c9b011-980e-4928-9430-e60e3a97c043", "bec472ed-dbeb-48b5-b978-0984394673a6" ], "subOrganizationIds": [], "tenantOrganizationIds": [], "isRoot": true, "isMaster": false, "subOrganizations": [], "environmentsCount": 2, "owner": { "id": "57e281b5-ec5b-4701-80a0-92a936a68da3", "username": "organization_owner", "firstName": "Organization", "lastName": "Owner", "email": "api.platform.qa+o_o@gmail.com", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "enabled": true, "idprovider_id": "mulesoft" } }, { "name": "Mule ESB", "id": "bea09f72-33ce-43ce-82fe-32f9f0bd49ea", "createdAt": "2015-03-13T18:03:28.484000+00:00", "updatedAt": "2015-03-13T18:03:28.494000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "clientId": "33d79234ef0746918ac2e56271ceafe7", "domain": "mule-esb", "idprovider_id": "mulesoft", "isFederated": false, "parentOrganizationIds": [ "f0c9b011-980e-4928-9430-e60e3a97c043", "bec472ed-dbeb-48b5-b978-0984394673a6" ], "subOrganizationIds": [], "tenantOrganizationIds": [], "isRoot": true, "isMaster": false, "subOrganizations": [], "environmentsCount": 2, "owner": { "id": "57e281b5-ec5b-4701-80a0-92a936a68da3", "username": "organization_owner", "firstName": "Organization", "lastName": "Owner", "email": "api.platform.qa+o_o@gmail.com", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "enabled": true, "idprovider_id": "mulesoft" } }, { "name": "CloudHub", "id": "d156efa0-04c3-41fa-a2d3-e0b428d2cb4e", "createdAt": "2015-03-13T18:03:28.525000+00:00", "updatedAt": "2015-03-13T18:03:28.547000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "clientId": "36b929441ead4576b2fcf66fa98a2ca9", "domain": "cloudhub", "idprovider_id": "mulesoft", "isFederated": false, "parentOrganizationIds": [ "f0c9b011-980e-4928-9430-e60e3a97c043", "bec472ed-dbeb-48b5-b978-0984394673a6" ], "subOrganizationIds": [], "tenantOrganizationIds": [], "isRoot": true, "isMaster": false, "subOrganizations": [], "environmentsCount": 2, "owner": { "id": "57e281b5-ec5b-4701-80a0-92a936a68da3", "username": "organization_owner", "firstName": "Organization", "lastName": "Owner", "email": "api.platform.qa+o_o@gmail.com", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "enabled": true, "idprovider_id": "mulesoft" } } ], "owner": { "id": "57e281b5-ec5b-4701-80a0-92a936a68da3", "username": "organization_owner", "firstName": "Organization", "lastName": "Owner", "email": "api.platform.qa+o_o@gmail.com", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "enabled": true, "idprovider_id": "mulesoft" } }, { "name": "Finance", "id": "0d12b66b-ee6a-4d66-b36c-6aeee637cde2", "createdAt": "2015-03-13T18:03:28.575000+00:00", "updatedAt": "2015-03-13T18:03:28.594000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "clientId": "1245b108cb7d4961931e59418d785002", "domain": "finance", "idprovider_id": "mulesoft", "isFederated": false, "parentOrganizationIds": [ "f0c9b011-980e-4928-9430-e60e3a97c043" ], "subOrganizationIds": [], "tenantOrganizationIds": [], "isRoot": true, "isMaster": false, "subOrganizations": [], "environmentsCount": 2, "owner": { "id": "57e281b5-ec5b-4701-80a0-92a936a68da3", "username": "organization_owner", "firstName": "Organization", "lastName": "Owner", "email": "api.platform.qa+o_o@gmail.com", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "enabled": true, "idprovider_id": "mulesoft" } } ] }

List Identity Providers listIdentityProviders

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns list of identity management providers for the root organization with a subset of values.

Path Parameters

organizationId *: string

Query Parameters

include_full_details *: boolean
provider_id: array
One or more ids of the provider(s) to return.
offset: integer
idp_type: array
One or more types of provider(s) to return.
ascending *: boolean
sort: string
limit: integer
search: string
A search string to use for case-insensitive partial matches on name

Response

json
Returns the list of identity management providers
data *: array
total *: number
Examples
application/json
{ "data": [ { "provider_id": "2e50e859-0042-46ff-8cf8-1ad6f0c78b67", "org_id": "2e71d283-6248-4c81-98eb-e254a89b7e0a", "name": "Primary Identity Management Config", "type": { "description": "OpenID Connect", "name": "openid" } } ], "total": 1 }

Create Identity Providers createIdentityProviders

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Add a new identity management provider to the root organization.

Path Parameters

organizationId *: string

Request Body

json

Response

Success

List Identity Providers Saml Sp Metadata listIdentityProvidersSamlSpMetadata

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Download the SAML SP metadata of the associated SAML identity management provider

Path Parameters

organizationId *: string

Query Parameters

provider_id *: string
ID of the provider to get the associated SAML SP metadata.

Response

Success

Create Identity Providers Ldap Test createIdentityProvidersLdapTest

POST

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Test the LDAP config before saving the configuration

Path Parameters

organizationId *: string

Query Parameters

provider_id: string
ID of the provider to get the associated LDAP config that's already persisted

Request Body

json
name: string
type *: object
connection *: object
search_bases *: object
dns *: object
filters *: object
user_mapping *: object
group_mapping *: object
test_connection *: object

Response

Success

Get Identity Providers getIdentityProviders

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns the associated identity management provider config.

Path Parameters

organizationId *: string
identityProviderId *: string

Query Parameters

include_secrets *: boolean

Response

Success

Update Identity Providers updateIdentityProviders

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the associated identity management provider config

Path Parameters

organizationId *: string
identityProviderId *: string

Request Body

json

Response

Success

Delete Identity Providers deleteIdentityProviders

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes the associated identity management provider

Path Parameters

organizationId *: string
identityProviderId *: string

Response

Success

List Identity Providers Saml Sp Keys listIdentityProvidersSamlSpKeys

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns the list of SAML SP keys associated to the identity management provider config

Path Parameters

organizationId *: string
identityProviderId *: string

Query Parameters

primary: boolean

Response

json
Success
items: array
Array items

Create Identity Providers Saml Sp Keys createIdentityProvidersSamlSpKeys

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Add or generate a new SAML SP key pair

Path Parameters

organizationId *: string
identityProviderId *: string

Request Body

json
key_pair: object

Response

json
Success
id *: string
primary *: boolean
created_at *: string
is_default_certificate: boolean

Get Identity Providers Saml Sp Keys getIdentityProvidersSamlSpKeys

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns the SAML SP certificate in .pem format

Path Parameters

organizationId *: string
identityProviderId *: string
samlSpKeyId *: string
The unique identifier of the saml sp key id.

Response

Success

Delete Identity Providers Saml Sp Keys deleteIdentityProvidersSamlSpKeys

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete the SAML SP key

Path Parameters

organizationId *: string
identityProviderId *: string
samlSpKeyId *: string
The unique identifier of the saml sp key id.

Response

Success

Create Identity Providers Saml Sp Keys Set Primary createIdentityProvidersSamlSpKeysSetPrimary

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Make the key the primary SAML SP key for the identity management provider config

Path Parameters

organizationId *: string
identityProviderId *: string
samlSpKeyId *: string
The unique identifier of the saml sp key id.

Response

json
Success
items: array
Array items

List Identity Provider Settings listIdentityProviderSettings

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get the identity provider settings for the org

Path Parameters

organizationId *: string

Response

json
Success
allow_new_non_sso_users: boolean
bypass_expiration: boolean

Update Identity Provider Settings updateIdentityProviderSettings

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update the identity provider settings for the org

Path Parameters

organizationId *: string

Request Body

json
allow_new_non_sso_users: boolean
bypass_expiration: boolean

Response

Success

List Organization Invites listOrganizationInvites

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
get outstanding or expired invites that match the criteria

Path Parameters

organizationId *: string

Query Parameters

offset: integer
limit: integer
search: string
A search string to use for case-insensitive partial matches on invited emails

Response

json
Success
data *: array
total *: number
Examples
application/json
{ "data": [ { "id": 520, "code": "f2e8dfab-6699-4889-831f-6dc6f8428cb0", "invited_at": "2015-01-30T22:23:55.433000+00:00", "invited_email": "christopher.mordue@mulesoft.com", "invited_by_user": { "id": "57e281b5-ec5b-4701-80a0-92a936a68da3", "username": "organization_owner", "first_name": "Organization2", "last_name": "Owner" }, "invited_to_org": { "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "name": "MuleSoft Inc" }, "expires_at": "2015-04-10T22:23:55.433000+00:00", "status": "INVITED", "completed_at": null, "completed_by_user": null, "role_groups": [ { "name": "Organization Administrators", "role_group_id": "0b19f6df-ed81-4fd1-b5e7-4921f5e46f4c" } ] } ], "total": 1 }

Create Organization Invite createOrganizationInvite

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Invite a person to join the organization

Path Parameters

organizationId *: string

Request Body

json

Response

json
Success
items: array
Array items

Delete Organization Invites deleteOrganizationInvites

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Invite a person to join your organization

Path Parameters

organizationId *: string

Request Body

json
items: array
Array items

Response

Success

Get Organization Invite getOrganizationInvite

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
get an invite

Path Parameters

organizationId *: string
inviteId *: integer
The ID of the invite

Response

Success

Resend Organization Invite resendOrganizationInvite

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Resend a list of invites

Path Parameters

organizationId *: string

Request Body

json
items: array
Array items

Response

json
Success
succeeded *: array
failed *: array

List Members listMembers

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get members from an organization

Path Parameters

organizationId *: string

Query Parameters

username *: string
Search users with the matching username
lastName *: string
Search users with the matching lastName
firstName *: string
Search users with the matching firstName
offset: integer
limit: integer
search *: string
Search string to find users. It will look up the string in the username, email, firstName and lastName

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "id": "4b353f44-6486-42ae-ae77-18b4032f9643", "username": "uzer1-test", "firstName": "Uzer", "lastName": "1", "email": "api.platform.qa+uzer@gmail.com", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "enabled": true, "idprovider_id": "mulesoft", "type": "host", "createdAt": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "updatedAt": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "lastLogin": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "password_updatedAt": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)" } ], "total": 1 }

Update Members updateMembers

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Add a group of users to the organization by their IDs

Path Parameters

organizationId *: string

Request Body

json
items: array
Request payload for Generated10.
Examples
application/json
[ "1c0d1a43-4d91-4b52-bcc6-cff8ecf0c3a3", "dc52bf66-b0d8-4cda-9ae8-45a5f085ead4", "5314c476-1cd4-49be-ba4e-1d67f6c052c3" ]

Response

Success

Delete Members deleteMembers

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Remove a group of users from the organization by their IDs

Path Parameters

organizationId *: string

Request Body

json
items: array
Request payload for Generated10.
Examples
application/json
[ "1c0d1a43-4d91-4b52-bcc6-cff8ecf0c3a3", "dc52bf66-b0d8-4cda-9ae8-45a5f085ead4", "5314c476-1cd4-49be-ba4e-1d67f6c052c3" ]

Response

Success

Update Organization Member updateOrganizationMember

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Add the user to the organization

Path Parameters

organizationId *: string
userId *: string

Request Body

json
items: array
Request payload for Generated10.
Examples
application/json
[ "1c0d1a43-4d91-4b52-bcc6-cff8ecf0c3a3", "dc52bf66-b0d8-4cda-9ae8-45a5f085ead4", "5314c476-1cd4-49be-ba4e-1d67f6c052c3" ]

Response

Success

Delete Organization Member deleteOrganizationMember

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Remove the user from the organization

Path Parameters

organizationId *: string
userId *: string

Request Body

json
items: array
Request payload for Generated10.
Examples
application/json
[ "1c0d1a43-4d91-4b52-bcc6-cff8ecf0c3a3", "dc52bf66-b0d8-4cda-9ae8-45a5f085ead4", "5314c476-1cd4-49be-ba4e-1d67f6c052c3" ]

Response

Success

List Owner listOwner

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
get owner for an organization

Path Parameters

organizationId *: string

Response

json
Success
id *: string
The unique identifier of the resource.
createdAt *: string
The date and time when the resource was created, in ISO 8601 format.
updatedAt *: string
The date and time when the resource was last updated, in ISO 8601 format.
lastLogin *: string
The date and time of the user's most recent successful login, in ISO 8601 format.
previousLastLogin *: string
The date and time of the user's previous successful login, in ISO 8601 format.
organizationId *: string
The unique identifier of the organization.
firstName *: string
The user's first name.
lastName *: string
The user's last name.
email *: string(email)
The user's email address.
phoneNumber *: string
The user's phone number.
username *: string
The username used to authenticate the user.
enabled *: boolean
Whether the feature or resource is currently enabled.
deleted *: boolean
Whether the resource has been marked as deleted.
idprovider_id *: string
The unique identifier of the identity provider.
Examples
application/json
{ "id": "1cddca41-f396-423c-b5b8-f2951a5ff716", "createdAt": "2015-07-28T00:05:57.605000+00:00", "updatedAt": "2015-07-28T00:05:57.688000+00:00", "lastLogin": "2015-07-29T00:05:57.688000+00:00", "previousLastLogin": "2015-07-28T00:05:57.688000+00:00", "organizationId": "41410427-5cb1-4b0a-9f18-259db3f8c942", "firstName": "Dustin91", "lastName": "Weber0", "email": "Marty_Sauer@elmore.io59", "phoneNumber": "111-111-1111", "username": "Hell0-W0rld_Yo0", "enabled": true, "deleted": false, "idprovider_id": "mulesoft" }

Update Owner updateOwner

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Switch out organization's owner to the one specified by userId

Path Parameters

organizationId *: string
userId *: string

Response

json
Success
id *: string
The unique identifier of the resource.
createdAt *: string
The date and time when the resource was created, in ISO 8601 format.
updatedAt *: string
The date and time when the resource was last updated, in ISO 8601 format.
lastLogin *: string
The date and time of the user's most recent successful login, in ISO 8601 format.
previousLastLogin *: string
The date and time of the user's previous successful login, in ISO 8601 format.
organizationId *: string
The unique identifier of the organization.
firstName *: string
The user's first name.
lastName *: string
The user's last name.
email *: string(email)
The user's email address.
phoneNumber *: string
The user's phone number.
username *: string
The username used to authenticate the user.
enabled *: boolean
Whether the feature or resource is currently enabled.
deleted *: boolean
Whether the resource has been marked as deleted.
idprovider_id *: string
The unique identifier of the identity provider.
Examples
application/json
{ "id": "1cddca41-f396-423c-b5b8-f2951a5ff716", "createdAt": "2015-07-28T00:05:57.605000+00:00", "updatedAt": "2015-07-28T00:05:57.688000+00:00", "lastLogin": "2015-07-29T00:05:57.688000+00:00", "previousLastLogin": "2015-07-28T00:05:57.688000+00:00", "organizationId": "41410427-5cb1-4b0a-9f18-259db3f8c942", "firstName": "Dustin91", "lastName": "Weber0", "email": "Marty_Sauer@elmore.io59", "phoneNumber": "111-111-1111", "username": "Hell0-W0rld_Yo0", "enabled": true, "deleted": false, "idprovider_id": "mulesoft" }

List Provider Users listProviderUsers

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns the identity provider details

Path Parameters

organizationId *: string

Response

json
Success
identity_management *: object
Configuration of the identity management integration for the organization.
Examples
application/json
{ "identity_management": { "type": { "name": "saml", "description": "SAML 2.0" }, "service_provider": { "name": "Identity Federation Service Provider", "urls": { "sign_on": "https://pingfederate:9031/idp/startSSO.ping?PartnerSpId=chris.localhost.mulesoft.com", "sign_out": "https://pingfederate:9031/idp/SLO.saml2" } }, "saml": { "name": "SAML 2.0", "issuer": "test.9.1.mulesoft.com", "public_key": [ "AAAA" ], "audience": "chris.localhost.mulesoft.com", "claims_mapping": { "group_attribute": "memberOf" } } } }

Update Provider Users updateProviderUsers

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the identity provider for the organization

Path Parameters

organizationId *: string

Request Body

json
identity_management *: any
idprovider_id: string

Response

Success

Delete Provider Users deleteProviderUsers

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Revert to using the default identity provider

Path Parameters

organizationId *: string

Response

Success

Create Ldap Test createLdapTest

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
To test the ldap identity provider configuration before persisting

Path Parameters

organizationId *: string

Request Body

json
identity_management *: object

Response

Success

List Provider Users Saml Sp Metadata listProviderUsersSamlSpMetadata

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Download the SAML SP metadata

Path Parameters

organizationId *: string

Response

Success

Create Proxyusers createProxyusers

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Creates a proxy user in an organization

Path Parameters

organizationId *: string
userId *: string
The unique identifier of the user.

Response

json
Success
id *: string
The unique identifier of the resource.
username *: string
The username used to authenticate the user.
firstName *: string
The user's first name.
lastName *: string
The user's last name.
email *: string
The user's email address.
enabled *: boolean
Whether the feature or resource is currently enabled.
deleted *: boolean
Whether the resource has been marked as deleted.
idprovider_id *: string
The unique identifier of the identity provider.
type *: string
The type of the resource.
createdAt *: string
The date and time when the resource was created, in ISO 8601 format.
updatedAt *: string
The date and time when the resource was last updated, in ISO 8601 format.
organizationId *: string
The unique identifier of the organization.
Examples
application/json
{ "id": "4b353f44-6486-42ae-ae77-18b4032f9643", "username": "7b633d56-de50-11e9-8a34-2a2ae2dbcce4:f0c9b011-980e-4928-9430-e60e3a97c043", "firstName": "", "lastName": "", "email": "", "enabled": true, "deleted": false, "idprovider_id": "mulesoft", "type": "proxy", "createdAt": "2019-09-24T00:36:58+00:00", "updatedAt": "2019-09-24T00:36:58+00:00", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043" }

List Rolegroups listRolegroups

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns all role groups that belong to this organization

Path Parameters

organizationId *: string

Query Parameters

displayProviderId: boolean
if true, force display of the provider_id property of external names

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "role_group_id": "a62d817d-bde8-4f32-a8f7-993905890b4a", "name": "Organization Administrators", "description": "Organization Administrators", "context_params": {}, "user_role_group_id": "0120071d-2c0d-4a71-9c76-718a7e3e54f1" } ], "total": 1 }

Create Rolegroups createRolegroups

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a role group for this org

Path Parameters

organizationId *: string

Request Body

json
name *: string
The display name of the resource.
description *: string
A human-readable description of the resource.
external_names *: array
Alternative names by which the resource is known in external systems.
Examples
application/json
{ "name": "Organization Administrators", "description": "Organization Administrators", "external_names": [ { "external_group_name": "administrators", "provider_id": "2e50e859-0042-46ff-8cf8-1ad6f0c78b67" } ] }

Response

json
Success
role_group_id *: string
The unique identifier of the role group (legacy term for team).
name *: string
The display name of the resource.
external_names *: array
Alternative names by which the resource is known in external systems.
description *: string
A human-readable description of the resource.
org_id *: string
The unique identifier of the organization.
editable *: boolean
Whether the resource can be edited by the current user.
created_at *: string
The date and time when the resource was created, in ISO 8601 format.
updated_at *: string
The date and time when the resource was last updated, in ISO 8601 format.
Examples
application/json
{ "role_group_id": "67f3b9a6-75f1-4b94-af44-7fbe2a9b7b57", "name": "Organization Administrators", "external_names": [ "administrators" ], "description": "Organization Administrators", "org_id": "832ee1d8-f2e1-4b3c-baf2-7db361f8d1a6", "editable": true, "created_at": "2015-02-02T22:27:50.593000+00:00", "updated_at": "2015-02-02T22:27:50.593000+00:00" }

Delete Rolegroups deleteRolegroups

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Deletes role groups that belong to this organization

Path Parameters

organizationId *: string

Request Body

json
items: array
Request payload for Generated10.
Examples
application/json
[ "1c0d1a43-4d91-4b52-bcc6-cff8ecf0c3a3", "dc52bf66-b0d8-4cda-9ae8-45a5f085ead4", "5314c476-1cd4-49be-ba4e-1d67f6c052c3" ]

Response

Success

Get Rolegroups getRolegroups

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a role group

Path Parameters

organizationId *: string
roleGroupId *: string

Query Parameters

displayProviderId: boolean
if true, force display of the provider_id property of external names

Response

json
Success
role_group_id *: string
The unique identifier of the role group (legacy term for team).
name *: string
The display name of the resource.
external_names *: array
Alternative names by which the resource is known in external systems.
description *: string
A human-readable description of the resource.
org_id *: string
The unique identifier of the organization.
editable *: boolean
Whether the resource can be edited by the current user.
created_at *: string
The date and time when the resource was created, in ISO 8601 format.
updated_at *: string
The date and time when the resource was last updated, in ISO 8601 format.
Examples
application/json
{ "role_group_id": "67f3b9a6-75f1-4b94-af44-7fbe2a9b7b57", "name": "Organization Administrators", "external_names": [ "administrators" ], "description": "Organization Administrators", "org_id": "832ee1d8-f2e1-4b3c-baf2-7db361f8d1a6", "editable": true, "created_at": "2015-02-02T22:27:50.593000+00:00", "updated_at": "2015-02-02T22:27:50.593000+00:00" }

Update Rolegroups updateRolegroups

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a role group

Path Parameters

organizationId *: string
roleGroupId *: string

Request Body

json
role_group_id: string
name: string
description: string
external_names: array

Response

json
Success
role_group_id *: string
The unique identifier of the role group (legacy term for team).
name *: string
The display name of the resource.
external_names *: array
Alternative names by which the resource is known in external systems.
description *: string
A human-readable description of the resource.
org_id *: string
The unique identifier of the organization.
editable *: boolean
Whether the resource can be edited by the current user.
created_at *: string
The date and time when the resource was created, in ISO 8601 format.
updated_at *: string
The date and time when the resource was last updated, in ISO 8601 format.
Examples
application/json
{ "role_group_id": "67f3b9a6-75f1-4b94-af44-7fbe2a9b7b57", "name": "Organization Administrators", "external_names": [ "administrators" ], "description": "Organization Administrators", "org_id": "832ee1d8-f2e1-4b3c-baf2-7db361f8d1a6", "editable": true, "created_at": "2015-02-02T22:27:50.593000+00:00", "updated_at": "2015-02-02T22:27:50.593000+00:00" }

Delete Organization Rolegroup deleteOrganizationRolegroup

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes a role group

Path Parameters

organizationId *: string
roleGroupId *: string

Response

Success

List Rolegroups Roles listRolegroupsRoles

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns all roles assigned to this role group

Path Parameters

organizationId *: string
roleGroupId *: string

Query Parameters

namepace: string
return only role assignments where a role contains a permission that is part of the given namespace

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "created_at": "2015-02-02T21:45:33.433000+00:00", "role_group_assignment_id": "380dbe7c-dc1d-4dcc-8b98-3669c767db29", "role_group_id": "d9029399-1415-473f-809c-263c8f7278fd", "role_id": "d74ef94a-4292-4896-b860-b05bd7f90d6d", "name": "Organization Owner", "description": "Organization Owner allows full administration of users and full access to create and manage all APIs", "internal": false, "org_id": "68ef9520-24e9-4cf2-b2f5-620025690913", "context_params": { "org": "68ef9520-24e9-4cf2-b2f5-620025690913" } } ], "total": 1 }

Create Rolegroups Roles createRolegroupsRoles

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Assigns roles to this role group

Path Parameters

organizationId *: string
roleGroupId *: string

Request Body

json
items: array
Request payload for Generated11.
Examples
application/json
[ { "role_id": "d74ef94a-4292-4896-b860-b05bd7f90d6d", "context_params": { "org": "68ef9520-24e9-4cf2-b2f5-620025690913" } } ]

Response

Success

Delete Rolegroups Roles deleteRolegroupsRoles

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Removes roles from this role group

Path Parameters

organizationId *: string
roleGroupId *: string

Request Body

json
items: array
Request payload for Generated11.
Examples
application/json
[ { "role_id": "d74ef94a-4292-4896-b860-b05bd7f90d6d", "context_params": { "org": "68ef9520-24e9-4cf2-b2f5-620025690913" } } ]

Response

Success

List Rolegroups Users listRolegroupsUsers

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns users assigned to this role group

Path Parameters

organizationId *: string
roleGroupId *: string

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "id": "462ddd98-edd2-423b-9218-9f8e0f4c42ba", "username": "anypointadmin", "firstName": "Admin", "lastName": "Admin", "email": "mulesoft.library+admin@gmail.com", "organizationId": "68ef9520-24e9-4cf2-b2f5-620025690913", "enabled": true, "idprovider_id": "mulesoft", "context_params": {} } ], "total": 1 }

Create Rolegroups Users createRolegroupsUsers

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Assigns a group of users to this role group

Path Parameters

organizationId *: string
roleGroupId *: string

Request Body

json
items: array
Request payload for Generated10.
Examples
application/json
[ "1c0d1a43-4d91-4b52-bcc6-cff8ecf0c3a3", "dc52bf66-b0d8-4cda-9ae8-45a5f085ead4", "5314c476-1cd4-49be-ba4e-1d67f6c052c3" ]

Response

Success

Delete Rolegroups Users deleteRolegroupsUsers

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Unassigns a group of users from this role group

Path Parameters

organizationId *: string
roleGroupId *: string

Request Body

json
items: array
Request payload for Generated10.
Examples
application/json
[ "1c0d1a43-4d91-4b52-bcc6-cff8ecf0c3a3", "dc52bf66-b0d8-4cda-9ae8-45a5f085ead4", "5314c476-1cd4-49be-ba4e-1d67f6c052c3" ]

Response

Success

Add User To Organization Rolegroup addUserToOrganizationRolegroup

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Assigns this user to the role group

Path Parameters

organizationId *: string
roleGroupId *: string
userId *: string

Response

Success

Remove User From Organization Rolegroup removeUserFromOrganizationRolegroup

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Removes this user from the role group

Path Parameters

organizationId *: string
roleGroupId *: string
userId *: string

Response

Success

Delete Roles deleteRoles

DELETE

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Remove assignments for a given context, the context for the roles being deleted should be sent on the query string

Path Parameters

organizationId *: string

Query Parameters

match *: string
<<contextParamName>> *: string

Response

Success

List Smtp listSmtp

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns the SMTP details

Path Parameters

organizationId *: string

Response

json
Success
host *: string
The hostname of the server.
port *: integer
The port on which the server is reachable.
secure *: boolean
Whether the connection should use TLS.
ignoreTLS *: boolean
Whether TLS certificate validation should be skipped for the connection.
username *: string
The username used to authenticate the user.
password *: string
The user's password. Write-only.
fromName *: string
The display name used in the from address of outbound emails.
fromAddress *: string(email)
The from address used in outbound emails.
Examples
application/json
{ "host": "smtp.gmail.com", "port": 465, "secure": true, "ignoreTLS": false, "username": "admin", "password": "admin", "fromName": "John Galt", "fromAddress": "john.galt@gmail.com" }

Update Smtp updateSmtp

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the SMTP details

Path Parameters

organizationId *: string

Request Body

json
host *: string
The hostname of the server.
port *: integer
The port on which the server is reachable.
secure *: boolean
Whether the connection should use TLS.
ignoreTLS *: boolean
Whether TLS certificate validation should be skipped for the connection.
username *: string
The username used to authenticate the user.
password *: string
The user's password. Write-only.
fromName *: string
The display name used in the from address of outbound emails.
fromAddress *: string(email)
The from address used in outbound emails.
Examples
application/json
{ "host": "smtp.gmail.com", "port": 465, "secure": true, "ignoreTLS": false, "username": "admin", "password": "admin", "fromName": "John Galt", "fromAddress": "john.galt@gmail.com" }

Response

Success

List Teams listTeams

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns all teams or search for teams or get a list of teams by ids

Path Parameters

organizationId *: string

Query Parameters

ancestor_team_id: array
team_id that must appear in the team's ancestor_team_ids.
team_id: array
parent_team_id: array
team_id of the immediate parent of the team to return.
offset: integer
ascending *: boolean
team_type: array
sort: string
limit: integer
search: string
A search string to use for case-insensitive partial matches on team name

Response

json
Success
data *: array
total *: number
Examples
application/json
{ "data": [ { "team_id": "f59632be-e43f-4c4f-a303-36b8b0623f29", "team_name": "IT", "org_id": "6cb9cf0c-de02-4403-ace9-1857c0d0425f", "org_name": "Mythical Bank", "team_type": "internal", "ancestor_team_ids": [ "6cad8143-5f3c-4258-8091-2e664819e7f3" ], "created_at": "2019-07-15T09:36:07.123000+00:00", "updated_at": "2019-07-15T09:36:07.123000+00:00" } ], "total": 1 }

Create Teams createTeams

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new team.

Path Parameters

organizationId *: string

Request Body

json
parent_team_id *: string
team_name *: string
team_type *: string

Response

json
Success
team_id *: string
org_id *: string
org_name *: string
The name of the root organization that manages the team.
team_name *: string
team_type *: string
The type of the team.
external_org_id: string
external_org_name: string
ancestor_team_ids *: array
Array of ancestor teams ids starting from either the internal or external root team down to this team's parent.
created_at: string(date-time)
The time the team was created.
updated_at: string(date-time)
The time the team was last modified.

Get Teams getTeams

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns the team

Path Parameters

organizationId *: string
teamId *: string

Response

json
Success
team_id *: string
org_id *: string
org_name *: string
The name of the root organization that manages the team.
team_name *: string
team_type *: string
The type of the team.
external_org_id: string
external_org_name: string
ancestor_team_ids *: array
Array of ancestor teams ids starting from either the internal or external root team down to this team's parent.
created_at: string(date-time)
The time the team was created.
updated_at: string(date-time)
The time the team was last modified.

Update Teams updateTeams

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update or move the team

Path Parameters

organizationId *: string
teamId *: string

Request Body

json
team_name: string
team_type: string

Response

json
Success
team_id *: string
org_id *: string
org_name *: string
The name of the root organization that manages the team.
team_name *: string
team_type *: string
The type of the team.
external_org_id: string
external_org_name: string
ancestor_team_ids *: array
Array of ancestor teams ids starting from either the internal or external root team down to this team's parent.
created_at: string(date-time)
The time the team was created.
updated_at: string(date-time)
The time the team was last modified.

Delete Teams deleteTeams

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete the team, including all child teams.

Path Parameters

organizationId *: string
teamId *: string

Response

Success.

Update Teams Parent updateTeamsParent

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Move the team and its child teams under a new parent team

Path Parameters

organizationId *: string
teamId *: string

Request Body

json
parent_team_id *: string

Response

json
Success
team_id *: string
org_id *: string
org_name *: string
The name of the root organization that manages the team.
team_name *: string
team_type *: string
The type of the team.
external_org_id: string
external_org_name: string
ancestor_team_ids *: array
Array of ancestor teams ids starting from either the internal or external root team down to this team's parent.
created_at: string(date-time)
The time the team was created.
updated_at: string(date-time)
The time the team was last modified.

List Teams Groupmappings listTeamsGroupmappings

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
get all group access mappings configured for the team

Path Parameters

organizationId *: string
teamId *: string

Query Parameters

membership_type?: array
Include the group access mappings that grant the provided membership type By default, all group access mappings are returned
offset: integer
limit: integer
search: string
A search string to use for case-insensitive partial matches on external group name

Response

json
Success
data *: array
total *: number
Examples
application/json
{ "data": [ { "membership_type": "member", "external_group_name": "admin_members", "provider_id": "2e50e859-0042-46ff-8cf8-1ad6f0c78b67" }, { "membership_type": "maintainer", "external_group_name": "admin_maintainers", "provider_id": "2e50e859-0042-46ff-8cf8-1ad6f0c78b67" } ], "total": 2 }

Update Teams Groupmappings updateTeamsGroupmappings

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Replace the entire list of group mappings associated with this team

Path Parameters

organizationId *: string
teamId *: string

Request Body

json
items: array
Array items

Response

Success

Update Organization Team Groupmappings updateOrganizationTeamGroupmappings

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
bulk add mappings and/or modify mappings' membership_type to the team. Removing mappings is not supported by this method.

Path Parameters

organizationId *: string
teamId *: string

Request Body

json
items: array
Array items

Response

Success

Delete Teams Groupmappings deleteTeamsGroupmappings

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
bulk remove mappings from the team

Path Parameters

organizationId *: string
teamId *: string

Request Body

json
items: array
Array items

Response

Success.

List Teams Roles listTeamsRoles

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
get all role assignments or search for role assignments

Path Parameters

organizationId *: string
teamId *: string

Query Parameters

role_id: array
return only role assignments containing one of the supplied role_ids
search: string
A search string to use for case-insensitive partial matches on role name
offset: integer
limit: integer

Response

json
Success
data *: array
total *: number
Examples
application/json
{ "data": [ { "role_id": "8b7caaba-e94a-11e4-b02c-1681e6b88ec1", "name": "Read Servers", "context_params": { "org": "7f30ff47-5917-4a5a-b94d-9fe029edc04d", "envId": "a4946d03-6da4-45e1-9bfb-5bfe029c7793" } }, { "role_id": "53823f29-6e57-4c42-acdb-e42a881a888f", "name": "Manage Servers", "context_params": { "org": "7f30ff47-5917-4a5a-b94d-9fe029edc04d", "envId": "4c4efd56-9232-4f41-bb5c-4990539d519f" } } ], "total": 2 }

Create Teams Roles createTeamsRoles

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
bulk assign roles to the team

Path Parameters

organizationId *: string
teamId *: string

Request Body

json
items: array
Array items

Response

Success

Delete Teams Roles deleteTeamsRoles

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
bulk unassign roles from the team

Path Parameters

organizationId *: string
teamId *: string

Request Body

json
items: array
Array items

Response

Success

List Teams Members listTeamsMembers

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
get all members or search for members of this team or get a list of members by ids

Path Parameters

organizationId *: string
teamId *: string

Query Parameters

membership_type: array
identity_type: array
displayUserDetails: boolean
member_ids: array
Include the members of the team that have ids in this list
offset: integer
ascending *: boolean
sort: string
limit: integer
search: string
A search string to use for case-insensitive partial matches on member name

Response

json
Success
data *: array
total *: number
Examples
application/json
{ "data": [ { "identity_type": "team", "id": "f59632be-e43f-4c4f-a303-36b8b0623f29", "team_name": "IT", "membership_type": "member", "is_assigned_via_external_groups": false, "created_at": "2019-07-15T09:36:07.123000+00:00", "updated_at": "2019-07-15T09:36:07.123000+00:00" } ], "total": 1 }

Update Teams Members updateTeamsMembers

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
bulk add users and/or modify users' membership_type to the team. Removing members is not supported by this method.

Path Parameters

organizationId *: string
teamId *: string

Request Body

json
items: array
Array items

Response

Success

Delete Teams Members deleteTeamsMembers

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
bulk remove user members from the team

Path Parameters

organizationId *: string
teamId *: string

Request Body

json
items: array
Array items

Response

Success.

Update Organization Team Member updateOrganizationTeamMember

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
add the user as a member of the team.

Path Parameters

organizationId *: string
teamId *: string
userId *: string

Request Body

json
membership_type *: string
Whether the member is a regular member or a maintainer. Only users may be team maintainers.

Response

Success.

Remove Organization Team Member removeOrganizationTeamMember

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
remove the user from the team.

Path Parameters

organizationId *: string
teamId *: string
userId *: string

Response

Success.

List Tenant Relationships listTenantRelationships

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
List Tenant Relationships by Root Organization

Path Parameters

organizationId *: string

Query Parameters

enabled: boolean
Used to filter by whether tenant relationship is enabled
incomingTrust: string
Used to filter by incoming trust value
offset: integer
outgoingTrust: string
Used to filter by outgoing trust value
ascending *: boolean
rel_type: array
Used to filter by type of Tenant Relationship
tenantKey: array
Used to filter by tenantKey value
sort: string
limit: integer

Response

json
Success
data *: array
total *: number
Examples
application/json
{ "data": [ { "id": "59ff9087-1727-4858-8745-a4cc211511f7", "organization": { "id": "a5272e5e-c834-4ab4-8a50-41d5e39c8797", "name": "My MuleSoft Org" }, "type": "SFDC_C2C", "enabled": true, "tenantKey": "core/env/core-org-id", "label": "Salesforce Org", "sources": [ "CSP" ], "createdAt": "2023-08-14T22:33:24+00:00", "updatedAt": "2023-08-14T22:33:24+00:00", "config": { "_type": "SFDC_C2C", "incomingTrusts": [ "sfdc.manageMuleSoftTenantConnection" ], "outgoingTrusts": [], "apiEndpoint": "https://example.my.salesforce.com" } } ], "total": 1 }

Create Tenant Relationships createTenantRelationships

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Establish manual tenant relationships

Path Parameters

organizationId *: string

Request Body

json
relationshipType *: string
The type of the Tenant Relationship
tenantKey *: string
The unique ID of the remote tenant. For SFDC_C2C type relationships, this must be a valid GDoT Tenant GUID value
label: string
Unique human-friendly name / label for the Tenant Relationship

Response

json
Success
tenantRelationship *: object

Get Tenant Relationships getTenantRelationships

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get a particular Tenant Relationship by ID

Path Parameters

organizationId *: string
relationshipId *: string

Response

json
Success
tenantRelationship *: object

Update Tenant Relationships updateTenantRelationships

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patch update a particular Tenant Relationship by ID

Path Parameters

organizationId *: string
relationshipId *: string

Request Body

json
enabled: boolean
Whether the Tenant Relationship should be enabled or not
label: string
An updated label for the Tenant Relationship

Response

json
Success
tenantRelationship *: object

Delete Tenant Relationships deleteTenantRelationships

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete a particular Tenant Relationship by ID

Path Parameters

organizationId *: string
relationshipId *: string

Response

Success

Update Tenant Relationships Repair updateTenantRelationshipsRepair

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Repairs certain types of connection errors between the MuleSoft org and the remote Tenant

Path Parameters

organizationId *: string
relationshipId *: string

Response

Success

Update My Tenant Relationship Status updateMyTenantRelationshipStatus

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update the status of a specific SFDC organization feature for tenant relationships

Path Parameters

organizationId *: string
statusKey *: string
The unique identifier of the status key.

Request Body

json
enabled *: boolean
Status of the SFDC organization feature

Response

Success
Examples
application/json
{}

List My Tenant Relationship Assignments listMyTenantRelationshipAssignments

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get business group assignments for the Tenant Relationship for the caller utilizing a C2C token

Path Parameters

organizationId *: string

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "trust": "sfdc.one", "context_params": [ { "org": "a248f5de-70c3-480e-a35f-35cee4d91c5d" } ] }, { "trust": "sfdc.two", "context_params": [ { "org": "a248f5de-70c3-480e-a35f-35cee4d91c5d", "envId": "6c611d76-8f9c-40be-86dd-e73458ad6b0c" }, { "org": "8b2ce61f-9ebb-4f2a-98e8-bfe730bb90a2" } ] } ], "total": 2 }

List Users listUsers

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a group of users that belong to the organization

Path Parameters

organizationId *: string

Query Parameters

type *: string
mfaVerificationExcluded *: boolean
Specify if you want to retrieve only users with a given mfaVerificationExcluded value
search: string
The query string to search for an user by username, firstName, lastName or email
deleted *: boolean

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "id": "4b353f44-6486-42ae-ae77-18b4032f9643", "username": "uzer1-test", "firstName": "Uzer", "lastName": "1", "email": "api.platform.qa+uzer@gmail.com", "email_verified_at": null, "enabled": true, "idprovider_id": "mulesoft", "type": "host", "createdAt": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "updatedAt": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "lastLogin": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organization": { "name": "MuleSoft Inc", "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "createdAt": "2015-02-03T00:20:06.125000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "updatedAt": "2015-02-03T00:20:06.205000+00:00", "clientId": "1e4ea687b8794c679fe325b2e3550a17", "domain": "mulesoft-inc", "idprovider_id": "mulesoft", "properties": { "defaultAccessManagementUi": "cs-ui" }, "entitlements": { "createSubOrgs": false, "createEnvironments": false, "hybrid": { "enabled": false }, "hybridInsight": false, "hybridAutoDiscoverProperties": true, "globalDeployment": false, "vCoresProduction": { "assigned": 1, "reassigned": 0 }, "vCoresSandbox": { "assigned": 1, "reassigned": 0 }, "vCoresDesign": { "assigned": 1, "reassigned": 0 }, "staticIps": { "assigned": 1, "reassigned": 0 }, "vpcs": { "assigned": 0, "reassigned": 0 }, "vpns": { "assigned": 0, "reassigned": 0 }, "networkConnections": { "assigned": 0, "reassigned": 0 }, "workerLoggingOverride": { "enabled": false }, "messaging": { "assigned": 0 }, "mqMessages": { "base": 0, "addOn": 0 }, "mqRequests": { "base": 0, "addOn": 0 }, "mqAdvancedFeatures": { "enabled": false }, "objectStoreRequestUnits": { "base": 0, "addOn": 0 }, "objectStoreKeys": { "base": 0, "addOn": 0 }, "gateways": { "assigned": 0 }, "designCenter": { "mozart": true, "api": true, "apiVisual": false, "apiExample": false }, "partnersProduction": { "assigned": 0 }, "partnersSandbox": { "assigned": 0 }, "tradingPartnersProduction": { "assigned": 0 }, "tradingPartnersSandbox": { "assigned": 0 }, "loadBalancer": { "assigned": 0, "reassigned": 0 }, "externalIdentity": true, "autoscaling": false, "armAlerts": false, "apis": { "enabled": true }, "apiCatalog": { "enabled": false }, "apiMonitoring": { "schedules": 0 }, "apiCommunityManager": { "enabled": false }, "apiExperienceHub": { "enabled": false }, "monitoringCenter": { "productSKU": 3, "rawStorageOverrideGB": 0, "dataRegion": "us-east-1", "productionUnits": 0, "preProductionUnits": 0, "storageBase": 0, "storageAddOn": 0 }, "apiQuery": { "enabled": false, "productSKU": 1 }, "apiQueryC360": { "enabled": false }, "rpa": { "enabled": false, "active": false, "composerVersion": "" }, "idp": { "enabled": false }, "AutomationCreditsDW": { "assigned": 0 }, "apiGovernance": { "enabled": true, "apisPerMonth": 5 }, "apiGovernanceDomain": { "domain": "ASSET" }, "crowd": { "hideApiManagerDesigner": false, "hideFormerApiPlatform": false, "environments": false }, "cam": { "enabled": false }, "exchange2": { "enabled": false, "assetUsageAndEngagement": { "enabled": false } }, "crowdSelfServiceMigration": { "enabled": false }, "kpiDashboard": { "enabled": false }, "pcf": false, "appViz": false, "workerClouds": { "assigned": 0, "reassigned": 0 }, "runtimeFabric": false, "runtimeFabricCloud": { "enabled": false }, "serviceMesh": { "enabled": false }, "flexGateway": { "enabled": false }, "managedGatewaySmall": { "assigned": 0, "reassigned": 0 }, "managedGatewayLarge": { "assigned": 0, "reassigned": 0 }, "rtfManagedGateway": { "enabled": false }, "composer": { "enabled": false, "tasksPerMonth": 100, "maxConnectors": 3, "unlimitedConnectors": false, "isHyperAutomation": false }, "muleDxWebIde": { "enabled": false }, "muleDxGenAI": { "enabled": false }, "muleDxEDA": { "enabled": false }, "usageBasedPricing": { "muleRuntimeIntegration": { "enabled": true, "flows": 100, "messages": 10000, "throughput": 10000000 } }, "usageBasedPricingLimits": { "cpu": { "base": 10.01, "extra": 0.01 }, "memory": { "base": 1.02, "extra": 20.01 } }, "highAvailability": { "clustering": false }, "cloudhub1": { "enabled": true }, "telemetryExporter": { "enabled": true } }, "isFederated": false, "isRoot": true, "isMaster": true, "parentOrganizationIds": [], "subOrganizationIds": [], "tenantOrganizationIds": [], "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" } }, "isApiConsumer": false } ], "total": 1 }

Create Users createUsers

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a single user under the organization

Path Parameters

organizationId *: string

Request Body

json
username *: string
The username used to authenticate the user.
firstName *: string
The user's first name.
lastName *: string
The user's last name.
email *: string(email)
The user's email address.
phoneNumber *: string
The user's phone number.
password *: string
The user's password. Write-only.
Examples
application/json
{ "username": "juanferrerorocher", "firstName": "Juan", "lastName": "Ferrer", "email": "jferrer@mulesoft.com", "phoneNumber": "111-111-1111", "password": "my_very_secure_password" }

Response

Success

Update Users updateUsers

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update a group of users

Path Parameters

organizationId *: string

Request Body

json
items: array
Request payload for Generated12.
Examples
application/json
[ { "id": "fe340288-9c90-4995-bf26-c6cbf45f16d5", "firstName": "Juan", "lastName": "Ferrer", "email": "jferrer@example.com", "phoneNumber": "111-111-1111", "enabled": true }, { "id": "03645ba9-80fd-4d5a-81a7-cec39272b8c2", "firstName": "John", "lastName": "Smith", "email": "jsmith@example.com", "phoneNumber": "222-222-2222", "enabled": true } ]

Response

Success

Delete Users deleteUsers

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Deletes a group of users

Path Parameters

organizationId *: string

Request Body

json
items: array
Request payload for Generated10.
Examples
application/json
[ "1c0d1a43-4d91-4b52-bcc6-cff8ecf0c3a3", "dc52bf66-b0d8-4cda-9ae8-45a5f085ead4", "5314c476-1cd4-49be-ba4e-1d67f6c052c3" ]

Response

Success

Get Users getUsers

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a single user

Path Parameters

organizationId *: string
userId *: string

Response

json
Success
id *: string
The unique identifier of the resource.
createdAt *: string
The date and time when the resource was created, in ISO 8601 format.
updatedAt *: string
The date and time when the resource was last updated, in ISO 8601 format.
lastLogin *: string
The date and time of the user's most recent successful login, in ISO 8601 format.
previousLastLogin *: string
The date and time of the user's previous successful login, in ISO 8601 format.
firstName *: string
The user's first name.
lastName *: string
The user's last name.
ipAllowlistExcluded *: boolean
Whether the resource is excluded from organization-level IP allowlist enforcement.
email *: string(email)
The user's email address.
email_verified_at *: string
The date and time when the user's email address was verified, in ISO 8601 format.
phoneNumber *: string
The user's phone number.
username *: string
The username used to authenticate the user.
enabled *: boolean
Whether the feature or resource is currently enabled.
deleted *: boolean
Whether the resource has been marked as deleted.
idprovider_id *: string
The unique identifier of the identity provider.
organization *: object
The organization that owns the resource.
properties *: object
Additional properties associated with the resource.
Examples
application/json
{ "id": "5197cdf3-36c9-4bcb-8840-5779e961c746", "createdAt": "2015-01-29T00:00:53.315000+00:00", "updatedAt": "2015-01-29T00:00:55.163000+00:00", "lastLogin": "2015-01-29T00:11:55.163000+00:00", "previousLastLogin": "2015-01-28T00:11:55.163000+00:00", "firstName": "Organization", "lastName": "Owner", "ipAllowlistExcluded": false, "email": "core_services@mulesoft.com", "email_verified_at": "2015-01-29T00:00:53.315000+00:00", "phoneNumber": "111-111-1111", "username": "max", "enabled": true, "deleted": false, "idprovider_id": "mulesoft", "organization": { "name": "MuleSoft Inc", "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "createdAt": "2015-02-03T00:20:06.125000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "updatedAt": "2015-02-03T00:20:06.205000+00:00", "clientId": "1e4ea687b8794c679fe325b2e3550a17", "domain": "mulesoft-inc", "idprovider_id": "mulesoft", "properties": { "defaultAccessManagementUi": "cs-ui" }, "entitlements": { "createSubOrgs": false, "createEnvironments": false, "hybrid": { "enabled": false }, "hybridInsight": false, "hybridAutoDiscoverProperties": true, "globalDeployment": false, "vCoresProduction": { "assigned": 1, "reassigned": 0 }, "vCoresSandbox": { "assigned": 1, "reassigned": 0 }, "vCoresDesign": { "assigned": 1, "reassigned": 0 }, "staticIps": { "assigned": 1, "reassigned": 0 }, "vpcs": { "assigned": 0, "reassigned": 0 }, "vpns": { "assigned": 0, "reassigned": 0 }, "networkConnections": { "assigned": 0, "reassigned": 0 }, "workerLoggingOverride": { "enabled": false }, "messaging": { "assigned": 0 }, "mqMessages": { "base": 0, "addOn": 0 }, "mqRequests": { "base": 0, "addOn": 0 }, "mqAdvancedFeatures": { "enabled": false }, "objectStoreRequestUnits": { "base": 0, "addOn": 0 }, "objectStoreKeys": { "base": 0, "addOn": 0 }, "gateways": { "assigned": 0 }, "designCenter": { "mozart": true, "api": true, "apiVisual": false, "apiExample": false }, "partnersProduction": { "assigned": 0 }, "partnersSandbox": { "assigned": 0 }, "tradingPartnersProduction": { "assigned": 0 }, "tradingPartnersSandbox": { "assigned": 0 }, "loadBalancer": { "assigned": 1, "reassigned": 0 }, "externalIdentity": true, "autoscaling": false, "armAlerts": false, "apis": { "enabled": true }, "apiCatalog": { "enabled": false }, "apiMonitoring": { "schedules": 0 }, "apiCommunityManager": { "enabled": false }, "apiExperienceHub": { "enabled": false }, "monitoringCenter": { "productSKU": 3, "rawStorageOverrideGB": 0, "dataRegion": "us-east-1", "productionUnits": 0, "preProductionUnits": 0, "storageBase": 0, "storageAddOn": 0 }, "apiQuery": { "enabled": false, "productSKU": 1 }, "apiQueryC360": { "enabled": false }, "rpa": { "enabled": false, "active": false, "composerVersion": "" }, "idp": { "enabled": false }, "AutomationCreditsDW": { "assigned": 0 }, "apiGovernance": { "enabled": true, "apisPerMonth": 5 }, "apiGovernanceDomain": { "domain": "ASSET" }, "crowd": { "hideApiManagerDesigner": false, "hideFormerApiPlatform": false, "environments": false }, "cam": { "enabled": false }, "exchange2": { "enabled": false, "assetUsageAndEngagement": { "enabled": false } }, "crowdSelfServiceMigration": { "enabled": false }, "kpiDashboard": { "enabled": false }, "pcf": false, "appViz": false, "workerClouds": { "assigned": 0, "reassigned": 0 }, "runtimeFabric": false, "runtimeFabricCloud": { "enabled": false }, "serviceMesh": { "enabled": false }, "flexGateway": { "enabled": false }, "managedGatewaySmall": { "assigned": 0, "reassigned": 0 }, "managedGatewayLarge": { "assigned": 0, "reassigned": 0 }, "rtfManagedGateway": { "enabled": false }, "composer": { "enabled": false, "tasksPerMonth": 100, "maxConnectors": 3, "unlimitedConnectors": false, "isHyperAutomation": false }, "muleDxWebIde": { "enabled": false }, "muleDxGenAI": { "enabled": false }, "muleDxEDA": { "enabled": false }, "usageBasedPricing": { "muleRuntimeIntegration": { "enabled": true, "flows": 100, "messages": 10000, "throughput": 10000000 } }, "usageBasedPricingLimits": { "cpu": { "base": 10.01, "extra": 0.01 }, "memory": { "base": 1.02, "extra": 20.01 } }, "highAvailability": { "clustering": false }, "cloudhub1": { "enabled": true }, "telemetryExporter": { "enabled": true } }, "isFederated": false, "isRoot": true, "isMaster": true, "parentOrganizationIds": [], "subOrganizationIds": [], "tenantOrganizationIds": [], "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" } }, "properties": {} }

Update Organization User updateOrganizationUser

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a single user. Modifying email may require reauthentication.

Path Parameters

organizationId *: string
userId *: string

Request Body

json
firstName *: string
The user's first name.
lastName *: string
The user's last name.
ipAllowlistExcluded *: boolean
Whether the resource is excluded from organization-level IP allowlist enforcement.
email *: string(email)
The user's email address.
phoneNumber *: string
The user's phone number.
enabled *: boolean
Whether the feature or resource is currently enabled.
properties *: object
Additional properties associated with the resource.
Examples
application/json
{ "firstName": "Juan", "lastName": "Ferrer", "ipAllowlistExcluded": true, "email": "jferrer@mulesoft.com", "phoneNumber": "111-111-1111", "enabled": true, "properties": { "cs_auth": { "country": "Argentina" } } }

Response

json
Success
id *: string
The unique identifier of the resource.
createdAt *: string
The date and time when the resource was created, in ISO 8601 format.
updatedAt *: string
The date and time when the resource was last updated, in ISO 8601 format.
lastLogin *: string
The date and time of the user's most recent successful login, in ISO 8601 format.
previousLastLogin *: string
The date and time of the user's previous successful login, in ISO 8601 format.
firstName *: string
The user's first name.
lastName *: string
The user's last name.
ipAllowlistExcluded *: boolean
Whether the resource is excluded from organization-level IP allowlist enforcement.
email *: string(email)
The user's email address.
email_verified_at *: string
The date and time when the user's email address was verified, in ISO 8601 format.
phoneNumber *: string
The user's phone number.
username *: string
The username used to authenticate the user.
enabled *: boolean
Whether the feature or resource is currently enabled.
deleted *: boolean
Whether the resource has been marked as deleted.
idprovider_id *: string
The unique identifier of the identity provider.
organization *: object
The organization that owns the resource.
properties *: object
Additional properties associated with the resource.
Examples
application/json
{ "id": "5197cdf3-36c9-4bcb-8840-5779e961c746", "createdAt": "2015-01-29T00:00:53.315000+00:00", "updatedAt": "2015-01-29T00:00:55.163000+00:00", "lastLogin": "2015-01-29T00:11:55.163000+00:00", "previousLastLogin": "2015-01-28T00:11:55.163000+00:00", "firstName": "Organization", "lastName": "Owner", "ipAllowlistExcluded": false, "email": "core_services@mulesoft.com", "email_verified_at": "2015-01-29T00:00:53.315000+00:00", "phoneNumber": "111-111-1111", "username": "max", "enabled": true, "deleted": false, "idprovider_id": "mulesoft", "organization": { "name": "MuleSoft Inc", "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "createdAt": "2015-02-03T00:20:06.125000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "updatedAt": "2015-02-03T00:20:06.205000+00:00", "clientId": "1e4ea687b8794c679fe325b2e3550a17", "domain": "mulesoft-inc", "idprovider_id": "mulesoft", "properties": { "defaultAccessManagementUi": "cs-ui" }, "entitlements": { "createSubOrgs": false, "createEnvironments": false, "hybrid": { "enabled": false }, "hybridInsight": false, "hybridAutoDiscoverProperties": true, "globalDeployment": false, "vCoresProduction": { "assigned": 1, "reassigned": 0 }, "vCoresSandbox": { "assigned": 1, "reassigned": 0 }, "vCoresDesign": { "assigned": 1, "reassigned": 0 }, "staticIps": { "assigned": 1, "reassigned": 0 }, "vpcs": { "assigned": 0, "reassigned": 0 }, "vpns": { "assigned": 0, "reassigned": 0 }, "networkConnections": { "assigned": 0, "reassigned": 0 }, "workerLoggingOverride": { "enabled": false }, "messaging": { "assigned": 0 }, "mqMessages": { "base": 0, "addOn": 0 }, "mqRequests": { "base": 0, "addOn": 0 }, "mqAdvancedFeatures": { "enabled": false }, "objectStoreRequestUnits": { "base": 0, "addOn": 0 }, "objectStoreKeys": { "base": 0, "addOn": 0 }, "gateways": { "assigned": 0 }, "designCenter": { "mozart": true, "api": true, "apiVisual": false, "apiExample": false }, "partnersProduction": { "assigned": 0 }, "partnersSandbox": { "assigned": 0 }, "tradingPartnersProduction": { "assigned": 0 }, "tradingPartnersSandbox": { "assigned": 0 }, "loadBalancer": { "assigned": 1, "reassigned": 0 }, "externalIdentity": true, "autoscaling": false, "armAlerts": false, "apis": { "enabled": true }, "apiCatalog": { "enabled": false }, "apiMonitoring": { "schedules": 0 }, "apiCommunityManager": { "enabled": false }, "apiExperienceHub": { "enabled": false }, "monitoringCenter": { "productSKU": 3, "rawStorageOverrideGB": 0, "dataRegion": "us-east-1", "productionUnits": 0, "preProductionUnits": 0, "storageBase": 0, "storageAddOn": 0 }, "apiQuery": { "enabled": false, "productSKU": 1 }, "apiQueryC360": { "enabled": false }, "rpa": { "enabled": false, "active": false, "composerVersion": "" }, "idp": { "enabled": false }, "AutomationCreditsDW": { "assigned": 0 }, "apiGovernance": { "enabled": true, "apisPerMonth": 5 }, "apiGovernanceDomain": { "domain": "ASSET" }, "crowd": { "hideApiManagerDesigner": false, "hideFormerApiPlatform": false, "environments": false }, "cam": { "enabled": false }, "exchange2": { "enabled": false, "assetUsageAndEngagement": { "enabled": false } }, "crowdSelfServiceMigration": { "enabled": false }, "kpiDashboard": { "enabled": false }, "pcf": false, "appViz": false, "workerClouds": { "assigned": 0, "reassigned": 0 }, "runtimeFabric": false, "runtimeFabricCloud": { "enabled": false }, "serviceMesh": { "enabled": false }, "flexGateway": { "enabled": false }, "managedGatewaySmall": { "assigned": 0, "reassigned": 0 }, "managedGatewayLarge": { "assigned": 0, "reassigned": 0 }, "rtfManagedGateway": { "enabled": false }, "composer": { "enabled": false, "tasksPerMonth": 100, "maxConnectors": 3, "unlimitedConnectors": false, "isHyperAutomation": false }, "muleDxWebIde": { "enabled": false }, "muleDxGenAI": { "enabled": false }, "muleDxEDA": { "enabled": false }, "usageBasedPricing": { "muleRuntimeIntegration": { "enabled": true, "flows": 100, "messages": 10000, "throughput": 10000000 } }, "usageBasedPricingLimits": { "cpu": { "base": 10.01, "extra": 0.01 }, "memory": { "base": 1.02, "extra": 20.01 } }, "highAvailability": { "clustering": false }, "cloudhub1": { "enabled": true }, "telemetryExporter": { "enabled": true } }, "isFederated": false, "isRoot": true, "isMaster": true, "parentOrganizationIds": [], "subOrganizationIds": [], "tenantOrganizationIds": [], "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" } }, "properties": {} }

Delete Organization User deleteOrganizationUser

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes a user

Path Parameters

organizationId *: string
userId *: string

Response

Success

List Users Manage Verifiers listUsersManageVerifiers

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns information about how to initiate a redirect to the
VaaS Verifier Management UI.

Path Parameters

organizationId *: string
userId *: string

Response

Success

Update Users Properties updateUsersProperties

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates an existing users properties in the platform user directory.

Path Parameters

organizationId *: string
userId *: string

Request Body

json
cs_auth *: object
Configuration for Anypoint Platform authentication settings.
Examples
application/json
{ "cs_auth": { "activeOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043" } }

Response

json
Success
cs_auth *: object
Configuration for Anypoint Platform authentication settings.
Examples
application/json
{ "cs_auth": { "activeOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043" } }

List Users Rolegroups listUsersRolegroups

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns the role groups assigned to the user

Path Parameters

organizationId *: string
userId *: string

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "role_group_id": "a62d817d-bde8-4f32-a8f7-993905890b4a", "name": "Organization Administrators", "description": "Organization Administrators", "context_params": {}, "user_role_group_id": "0120071d-2c0d-4a71-9c76-718a7e3e54f1" } ], "total": 1 }

Create Users Rolegroups createUsersRolegroups

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Assigns the role group to the user

Path Parameters

organizationId *: string
userId *: string
roleGroupId *: string

Response

Success

Delete Users Rolegroups deleteUsersRolegroups

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Unassigns the role group from the user

Path Parameters

organizationId *: string
userId *: string
roleGroupId *: string

Response

Success

List Users Roles listUsersRoles

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of roles/permissions assigned to the user, excluding inherited roles/permissions.
Note: the /authorize API is more appropriate for checking authorization against assigned permissions.

Path Parameters

organizationId *: string
userId *: string

Query Parameters

role_groups: boolean
include permissions assigned via Business Group Role (a.k.a Role Group) membership
teams: boolean
include permissions assigned via Team membership
namespace: string
return only role/permission assignments where a role contains a permission that is part of the given namespace

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "role_id": "73a5c3c3-ef75-4291-b51e-a69f998eeea2", "context_params": { "org": "a248f5de-70c3-480e-a35f-35cee4d91c5d" }, "name": "Organization Owner", "description": "Organization Owner allows full administration of users and full access to create and manage all APIs" }, { "role_id": "96bf8032-9e54-4031-9bee-bc5f59f9f4e5", "context_params": { "org": "a248f5de-70c3-480e-a35f-35cee4d91c5d", "user": "6c611d76-8f9c-40be-86dd-e73458ad6b0c" }, "name": "Business Group Viewer", "description": "Business Group Viewer" } ], "total": 2 }

Create Users Roles createUsersRoles

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Bulk assign roles to the user

Path Parameters

organizationId *: string
userId *: string

Request Body

json
d74ef94a-4292-4896-b860-b05bd7f90d6d *: object
Per-resource entry keyed by identifier.
Examples
application/json
{ "d74ef94a-4292-4896-b860-b05bd7f90d6d": { "org": "68ef9520-24e9-4cf2-b2f5-620025690913" } }

Response

Success

Add Role To Organization User addRoleToOrganizationUser

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Assign a role to the user

Path Parameters

organizationId *: string
userId *: string
roleId *: string

Request Body

json
org *: string
The organization slug or short identifier used in API paths.
envId *: string
The unique identifier of the environment.
Examples
application/json
{ "org": "68ef9520-24e9-4cf2-b2f5-620025690913", "envId": "11152f65-b6fc-4de6-872e-5d03cdc79c89" }

Response

Success

Delete Users Roles deleteUsersRoles

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Unassign a role from the user

Path Parameters

organizationId *: string
userId *: string
roleId *: string

Request Body

json
org *: string
The organization slug or short identifier used in API paths.
envId *: string
The unique identifier of the environment.
Examples
application/json
{ "org": "68ef9520-24e9-4cf2-b2f5-620025690913", "envId": "11152f65-b6fc-4de6-872e-5d03cdc79c89" }

Response

Success

List Users Teams listUsersTeams

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of teams the user is a member of

Path Parameters

organizationId *: string
userId *: string

Query Parameters

ancestor_team_id: array
team_id that must appear in the team's ancestor_team_ids.
membership_type: array
return only teams where the user is this type of member
parent_team_id: array
team_id of the immediate parent of the team to return.
offset: integer
ascending *: boolean
team_type: array
return only teams that are of this type
sort: string
limit: integer
search: string
A search string to use for case-insensitive partial matches on team name

Response

json
Success
data *: array
total *: number
Examples
application/json
{ "data": [ { "team_id": "f59632be-e43f-4c4f-a303-36b8b0623f29", "team_name": "IT", "org_id": "6cb9cf0c-de02-4403-ace9-1857c0d0425f", "org_name": "Mythical Bank", "team_type": "internal", "ancestor_team_ids": [ "6cad8143-5f3c-4258-8091-2e664819e7f3" ], "created_at": "2019-07-15T09:36:07.123000+00:00", "updated_at": "2019-07-15T09:36:07.123000+00:00", "membership_type": "maintainer", "is_assigned_via_external_groups": false } ], "total": 1 }

Delete Users Verifiers deleteUsersVerifiers

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Revokes all mfa verifiers associated with the user

Path Parameters

organizationId *: string
userId *: string

Response

Success

List Users Identity Provider Profiles listUsersIdentityProviderProfiles

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns the list of the identity provider profiles of the user

Path Parameters

organizationId *: string
userId *: string

Response

json
items: array
Response payload for listUsersIdentityProviderProfiles.
Examples
application/json
[ { "idpUserId": "hello.world@mulesoft.com", "idpUserName": null, "userId": "f3f50b81-baf8-1830-b821-6f1477171c7d", "providerId": "45532a06-108d-4bec-8247-1bf207ba006d", "loginProfileData": "{\"idpUserId\":\"hello.world@mulesoft.com\"}", "createdAt": "2023-01-19T23:22:36.212000+00:00", "updatedAt": "2023-01-19T23:22:36.212000+00:00", "isFederated": true, "lastLoginAt": "2023-04-19T23:22:36.212000+00:00" } ]

Delete Users Identity Provider Profiles deleteUsersIdentityProviderProfiles

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Removes an identity provider profile from a user

Path Parameters

organizationId *: string
userId *: string

Request Body

json
idpUserId *: string(email)
The identifier of the user as recorded in the external identity provider.
providerId *: string
The unique identifier of the identity provider.
Examples
application/json
{ "idpUserId": "idpUserFromOkta@gmail.com", "providerId": "03bf5aff-a0e2-4e1a-8377-b7e4f67750df" }

Response

Success.

List Profile listProfile

GET

Try it out

Custom Query Parameters
Custom Headers
Returns the user bound to the provided access token

Response

json
Success
id *: string
The unique identifier of the resource.
createdAt *: string
The date and time when the resource was created, in ISO 8601 format.
updatedAt *: string
The date and time when the resource was last updated, in ISO 8601 format.
lastLogin *: string
The date and time of the user's most recent successful login, in ISO 8601 format.
previousLastLogin *: string
The date and time of the user's previous successful login, in ISO 8601 format.
firstName *: string
The user's first name.
lastName *: string
The user's last name.
email *: string(email)
The user's email address.
phoneNumber *: string
The user's phone number.
username *: string
The username used to authenticate the user.
enabled *: boolean
Whether the feature or resource is currently enabled.
deleted *: boolean
Whether the resource has been marked as deleted.
idprovider_id *: string
The unique identifier of the identity provider.
type *: string
The type of the resource.
organizationId *: string
The unique identifier of the organization.
organization *: object
The organization that owns the resource.
organizationPreferences *: object
Per-organization user preferences.
properties *: object
Additional properties associated with the resource.
memberOfOrganizations *: array
The organizations the user is a member of.
contributorOfOrganizations *: array
The organizations the user has contributor access to.
access_token *: string
The OAuth 2.0 access token issued to the client.
permissions *: object
The permissions assigned to the resource.
Examples
application/json
{ "id": "57e281b5-ec5b-4701-80a0-92a936a68da3", "createdAt": "2015-03-13T18:03:21.748000+00:00", "updatedAt": "2015-03-13T18:03:28.089000+00:00", "lastLogin": "2015-03-13T18:16:28.089000+00:00", "previousLastLogin": "2015-03-12T18:16:28.089000+00:00", "firstName": "Organization", "lastName": "Owner", "email": "api.platform.qa+o_o@gmail.com", "phoneNumber": "111-111-1111", "username": "organization_owner", "enabled": true, "deleted": false, "idprovider_id": "mulesoft", "type": "host", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organization": { "name": "MuleSoft Inc", "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "createdAt": "2015-03-13T18:03:23.869000+00:00", "updatedAt": "2015-03-13T18:03:24.207000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "clientId": "b63237d9c5d444ea95147065e0711161", "domain": "mulesoft-inc", "idprovider_id": "mulesoft", "isFederated": false, "parentOrganizationIds": [], "subOrganizationIds": [ "07fd6c5b-0036-48a3-b2af-3194c06bed6c" ], "tenantOrganizationIds": [], "isRoot": true, "isMaster": true, "properties": { "defaultAccessManagementUi": "cs-ui" }, "entitlements": { "partnersProduction": { "assigned": 0 }, "partnersSandbox": { "assigned": 0 }, "tradingPartnersProduction": { "assigned": 0 }, "tradingPartnersSandbox": { "assigned": 0 }, "createSubOrgs": false, "createEnvironments": false, "hybrid": { "enabled": false }, "hybridInsight": true, "hybridAutoDiscoverProperties": true, "globalDeployment": false, "vCoresProduction": { "assigned": 1, "reassigned": 0 }, "vCoresSandbox": { "assigned": 1, "reassigned": 0 }, "vCoresDesign": { "assigned": 1, "reassigned": 0 }, "staticIps": { "assigned": 1, "reassigned": 0 }, "vpcs": { "assigned": 0, "reassigned": 0 }, "vpns": { "assigned": 0, "reassigned": 0 }, "networkConnections": { "assigned": 0, "reassigned": 0 }, "workerLoggingOverride": { "enabled": false }, "messaging": { "assigned": 0 }, "mqMessages": { "base": 0, "addOn": 0 }, "mqRequests": { "base": 0, "addOn": 0 }, "mqAdvancedFeatures": { "enabled": false }, "objectStoreRequestUnits": { "base": 0, "addOn": 0 }, "objectStoreKeys": { "base": 0, "addOn": 0 }, "gateways": { "assigned": 0 }, "designCenter": { "mozart": true, "api": true, "apiVisual": false, "apiExample": false }, "loadBalancer": { "assigned": 0, "reassigned": 0 }, "externalIdentity": true, "autoscaling": false, "armAlerts": false, "apis": { "enabled": true }, "apiCatalog": { "enabled": false }, "apiMonitoring": { "schedules": 0 }, "apiCommunityManager": { "enabled": false }, "apiExperienceHub": { "enabled": false }, "monitoringCenter": { "productSKU": 3, "rawStorageOverrideGB": 0, "dataRegion": "us-east-1", "productionUnits": 0, "preProductionUnits": 0, "storageBase": 0, "storageAddOn": 0 }, "apiQuery": { "enabled": false, "productSKU": 1 }, "apiQueryC360": { "enabled": false }, "rpa": { "enabled": false, "active": false, "composerVersion": "" }, "idp": { "enabled": false }, "AutomationCreditsDW": { "assigned": 0 }, "apiGovernance": { "enabled": true, "apisPerMonth": 5 }, "apiGovernanceDomain": { "domain": "ASSET" }, "crowd": { "hideApiManagerDesigner": false, "hideFormerApiPlatform": false, "environments": false }, "cam": { "enabled": false }, "exchange2": { "enabled": false, "assetUsageAndEngagement": { "enabled": false } }, "crowdSelfServiceMigration": { "enabled": false }, "kpiDashboard": { "enabled": false }, "pcf": false, "appViz": false, "workerClouds": { "assigned": 0, "reassigned": 0 }, "runtimeFabric": false, "runtimeFabricCloud": { "enabled": false }, "serviceMesh": { "enabled": false }, "flexGateway": { "enabled": false }, "managedGatewaySmall": { "assigned": 0, "reassigned": 0 }, "managedGatewayLarge": { "assigned": 0, "reassigned": 0 }, "rtfManagedGateway": { "enabled": false }, "composer": { "enabled": false, "tasksPerMonth": 100, "maxConnectors": 3, "unlimitedConnectors": false, "isHyperAutomation": false }, "muleDxWebIde": { "enabled": false }, "muleDxGenAI": { "enabled": false }, "muleDxEDA": { "enabled": false }, "usageBasedPricing": { "muleRuntimeIntegration": { "enabled": true, "flows": 100, "messages": 10000, "throughput": 10000000 } }, "usageBasedPricingLimits": { "cpu": { "base": 10.01, "extra": 0.01 }, "memory": { "base": 1.02, "extra": 20.01 } }, "highAvailability": { "clustering": false }, "cloudhub1": { "enabled": true }, "telemetryExporter": { "enabled": true } }, "owner": { "id": "57e281b5-ec5b-4701-80a0-92a936a68da3", "username": "organization_owner", "firstName": "Organization", "lastName": "Owner", "email": "api.platform.qa+o_o@gmail.com", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "enabled": true }, "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" }, "environments": [ { "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "name": "Production", "isProduction": true, "type": "production", "clientId": "abdf31490ba44484a1de789baf685e37" } ], "salesforce": { "sf_org_id": "00DSG00000CoJa78Ab", "apiEndpoint": "https://example.my.salesforce.com" } }, "organizationPreferences": { "f0c9b011-980e-4928-9430-e60e3a97c043": { "defaultEnvironment": "a6217e66-faf1-4c17-bbbc-8c008ef4c8c6" } }, "properties": {}, "memberOfOrganizations": [ { "name": "MuleSoft Inc", "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "createdAt": "2015-03-13T18:03:23.869000+00:00", "updatedAt": "2015-03-13T18:03:24.207000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "clientId": "b63237d9c5d444ea95147065e0711161", "domain": "mulesoft-inc", "idprovider_id": "mulesoft", "isFederated": false, "parentId": null, "parentName": null, "parentOrganizationIds": [], "subOrganizationIds": [ "07fd6c5b-0036-48a3-b2af-3194c06bed6c" ], "tenantOrganizationIds": [], "isRoot": true, "isMaster": true, "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" } } ], "contributorOfOrganizations": [ { "name": "MuleSoft Inc", "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "createdAt": "2015-03-13T18:03:23.869000+00:00", "updatedAt": "2015-03-13T18:03:24.207000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "clientId": "b63237d9c5d444ea95147065e0711161", "domain": "mulesoft-inc", "idprovider_id": "mulesoft", "isFederated": false, "parentId": null, "parentName": null, "parentOrganizationIds": [], "subOrganizationIds": [ "07fd6c5b-0036-48a3-b2af-3194c06bed6c" ], "tenantOrganizationIds": [], "isRoot": true, "isMaster": true, "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" } } ], "access_token": "ce4a34a6-4d89-43dc-9696-29df56cf0b1b", "permissions": { "admin": { "view": false }, "cloudhub": { "view": true }, "exchange": { "view": true }, "support": { "view": true }, "partner_manager": { "view": true } } }

Create Recover Password createRecoverPassword

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
sends a 'forgot password' email with password reset link to the email associated with the given username

Request Body

json
username *: string
Examples
application/json
{ "username": "cmordue" }

Response

email was sent or user with username does not exist

List Recover Password listRecoverPassword

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Checks the validity of the password reset code

Path Parameters

recoverCode *: string
A code sent in a password reset email used to prove the bearer has the right to change a user's password

Response

the code is valid

Create Recover Password By Code createRecoverPasswordByCode

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Sets a new password for the user associated with the password reset code

Path Parameters

recoverCode *: string
A code sent in a password reset email used to prove the bearer has the right to change a user's password

Request Body

json
password *: string
confirmPassword *: string
Examples
application/json
{ "password": "Password1", "confirmPassword": "Password1" }

Response

the password was successfully reset

Create Recover Username createRecoverUsername

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
sends email with list of usernames associated with the given email

Request Body

json
email *: string
Examples
application/json
{ "email": "christopher.mordue@mulesoft.com" }

Response

email was sent or no users are associated with the given email

List Roles listRoles

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of roles

Query Parameters

name: string
The name of a role
description: string
The description of a role
include_internal: boolean
offset: integer
limit: integer
search: string
A search string to use for case-insensitive partial matches on role names
sort: string
ascending *: boolean

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "role_id": "e5df881e-e2e8-11e4-8a00-1681e6b88ec1", "name": "Add Server Groups", "description": "Being able to create server group resources", "internal": false, "org_id": null, "namespaces": [], "product": "Runtime Manager" }, { "role_id": "fa6b43ac-c436-11e4-8dfc-aa07a5b093db", "name": "Add Servers", "description": "Being able to create server resources", "internal": false, "org_id": null, "namespaces": [], "product": "Runtime Manager" } ], "total": 2 }

Get Roles getRoles

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a single role by ID

Path Parameters

roleId *: string

Response

Success

List Roles Users listRolesUsers

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns users for a single role. This endpoint is rate lmited.

Path Parameters

roleId *: string

Response

Success

List Roles Permissions listRolesPermissions

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
List permissions assigned to a given role

Path Parameters

roleId *: string

Response

json
Success
data *: integer
The list of items returned by the request.
Examples
application/json
{ "data": 5 }

Create Roles Rolegroups Search createRolesRolegroupsSearch

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Search rolegroups by role assignments

Request Body

json
items: array
Array items
Examples
application/json
[ { "name": "expression", "operator": "AND", "operands": [ { "role_id": "b7711f5b-6d74-440b-84f1-0648e84f8ebc", "context_params": { "org": "8b2ce61f-9ebb-4f2a-98e8-bfe730bb90a2" }, "match_type": "exact" }, { "role_id": "b5860f29-7e8e-4a87-8264-b3759d976e90", "context_params": { "org": "8b2ce61f-9ebb-4f2a-98e8-bfe730bb90a2" }, "match_type": "partial" } ] }, { "name": "pagination", "limit": 25, "offset": 0 }, { "name": "sort", "order": "ASC", "field": "role_group_id" } ]

Response

json
Success
data *: array
total *: integer

Create Roles Teams Search createRolesTeamsSearch

POST

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Search teams by role assignments

Query Parameters

include_inherited: string
Include child teams who inherited the matching permissions

Request Body

json
items: array
Array items
Examples
application/json
[ { "name": "expression", "operator": "AND", "operands": [ { "role_id": "b7711f5b-6d74-440b-84f1-0648e84f8ebc", "context_params": { "org": "8b2ce61f-9ebb-4f2a-98e8-bfe730bb90a2" }, "match_type": "exact" }, { "role_id": "b5860f29-7e8e-4a87-8264-b3759d976e90", "context_params": { "org": "8b2ce61f-9ebb-4f2a-98e8-bfe730bb90a2" }, "match_type": "partial" } ] }, { "name": "pagination", "limit": 25, "offset": 0 }, { "name": "sort", "order": "ASC", "field": "team_name" } ]

Response

json
Success
data *: array
total *: number
Examples
application/json
{ "data": [ { "team_id": "f59632be-e43f-4c4f-a303-36b8b0623f29", "team_name": "IT", "org_id": "6cb9cf0c-de02-4403-ace9-1857c0d0425f", "org_name": "Mythical Bank", "team_type": "internal", "ancestor_team_ids": [ "6cad8143-5f3c-4258-8091-2e664819e7f3" ], "created_at": "2019-07-15T09:36:07.123000+00:00", "updated_at": "2019-07-15T09:36:07.123000+00:00", "assignments": [ { "role_id": "53823f29-6e57-4c42-acdb-e42a881a888f", "name": "Manage Servers", "context_params": { "org": "7f30ff47-5917-4a5a-b94d-9fe029edc04d", "envId": "4c4efd56-9232-4f41-bb5c-4990539d519f" }, "created_at": "2019-10-21T11:11:48.204521-07:00" } ] } ], "total": 1 }

List All Roles Users listAllRolesUsers

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Retrieve users by roles

Query Parameters

role_groups *: boolean
teams *: boolean

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "id": "d5d309ee-8c23-49e3-bec1-70ee99c42061", "username": "Immanuel1234", "firstName": "Immanuel", "lastName": "Jagerson", "email": "Immanuel@gmail.com", "enabled": true, "idprovider_id": "mulesoft", "type": "host", "createdAt": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "updatedAt": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "lastLogin": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "organizationId": "7f30ff47-5917-4a5a-b94d-9fe029edc04d", "assignments": [ { "role_id": "833ab9ca-0c72-45ba-9764-1df83240db57", "context_params": { "org": "7f30ff47-5917-4a5a-b94d-9fe029edc04d", "user": "d5d309ee-8c23-49e3-bec1-70ee99c42061" }, "created_at": "2019-10-21T11:11:48.204521-07:00" }, { "role_id": "e3284047-6334-4580-b441-53afe7598b6e", "context_params": { "org": "7f30ff47-5917-4a5a-b94d-9fe029edc04d", "envId": "4c4efd56-9232-4f41-bb5c-4990539d519f" }, "created_at": "2019-10-21T11:11:48.204521-07:00" } ] } ], "total": 1 }

Create Roles Users Search createRolesUsersSearch

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Seach users by role assignments

Request Body

json
items: array
Array items
Examples
application/json
[ { "name": "expression", "operator": "AND", "operands": [ { "role_id": "b7711f5b-6d74-440b-84f1-0648e84f8ebc", "context_params": { "org": "8b2ce61f-9ebb-4f2a-98e8-bfe730bb90a2" }, "match_type": "exact" }, { "role_id": "b5860f29-7e8e-4a87-8264-b3759d976e90", "context_params": { "org": "8b2ce61f-9ebb-4f2a-98e8-bfe730bb90a2" }, "match_type": "partial" } ] }, { "name": "pagination", "limit": 25, "offset": 0 }, { "name": "sort", "order": "ASC", "field": "id" } ]

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "id": "d5d309ee-8c23-49e3-bec1-70ee99c42061", "username": "Immanuel1234", "firstName": "Immanuel", "lastName": "Jagerson", "email": "Immanuel@gmail.com", "enabled": true, "idprovider_id": "mulesoft", "type": "host", "createdAt": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "updatedAt": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "lastLogin": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "organizationId": "7f30ff47-5917-4a5a-b94d-9fe029edc04d", "assignments": [ { "role_id": "833ab9ca-0c72-45ba-9764-1df83240db57", "context_params": { "org": "7f30ff47-5917-4a5a-b94d-9fe029edc04d", "user": "d5d309ee-8c23-49e3-bec1-70ee99c42061" }, "created_at": "2019-10-21T11:11:48.204521-07:00" }, { "role_id": "e3284047-6334-4580-b441-53afe7598b6e", "context_params": { "org": "7f30ff47-5917-4a5a-b94d-9fe029edc04d", "envId": "4c4efd56-9232-4f41-bb5c-4990539d519f" }, "created_at": "2019-10-21T11:11:48.204521-07:00" } ] } ], "total": 1 }

List Session listSession

GET

Try it out

Custom Query Parameters
Custom Headers
Retrieves session timeout meta data

Response

json
Success
timeout *: object
The timeout for the operation, in milliseconds.
Examples
application/json
{ "timeout": { "unit": "milliseconds", "duration": 3600000, "timeLeft": 3599968, "timeUsed": 32, "expires": 1422910648297 } }

Create Session createSession

POST

Try it out

Custom Query Parameters
Custom Headers
Extend the session timeout time

Response

Success

List Signup listSignup

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Retrieves data about joining an organization via invite code

Query Parameters

code *: string
Invite code

Response

json
Success
organizationName *: string
The display name of the organization.
organizationId *: string
The unique identifier of the organization.
email *: string(email)
The user's email address.
userAccounts *: array
The user accounts associated with the resource.
termsAccepted *: boolean
Whether the user has accepted the terms of service.
Examples
application/json
{ "organizationName": "MuleSoft Inc", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "email": "fake-email@mulesoft.com", "userAccounts": [ { "username": "Hell0-W0rld_Yo1", "attachedOrg": true }, { "username": "Hell0-W0rld_Yo2", "attachedOrg": false } ], "termsAccepted": true }

Create Signup createSignup

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new user and organization, or accepts an invite to join an existing organization.
Supports two modes: full signup or accepting an invite via code.
Authentication: For full signup, either provide captchaCode or Authorization header.

Request Body

json
Examples
accept-invite
{ "username": "cmordue", "password": "Password1", "confirmPassword": "Password1", "email": "christopher.mordue@mulesoft.com", "firstName": "Chris", "lastName": "Mordue", "phoneNumber": "123-456-7890", "code": "53c66866-b373-46e8-8a95-0505c16578d0", "termsAccepted": true }
full-signup
{ "username": "newuser123", "password": "SecurePassword1!", "confirmPassword": "SecurePassword1!", "email": "newuser@example.com", "firstName": "John", "lastName": "Doe", "phoneNumber": "555-123-4567", "organizationName": "Acme Corporation", "termsAccepted": true, "captchaCode": "captcha-response-token-here", "country": "US", "state": "California", "title": "Software Engineer", "numberOfEmployees": "100" }

Response

json
Success
id *: string
The unique identifier of the resource.
createdAt *: string
The date and time when the resource was created, in ISO 8601 format.
updatedAt *: string
The date and time when the resource was last updated, in ISO 8601 format.
lastLogin *: string
The date and time of the user's most recent successful login, in ISO 8601 format.
previousLastLogin *: string
The date and time of the user's previous successful login, in ISO 8601 format.
firstName *: string
The user's first name.
lastName *: string
The user's last name.
ipAllowlistExcluded *: boolean
Whether the resource is excluded from organization-level IP allowlist enforcement.
email *: string(email)
The user's email address.
email_verified_at *: string
The date and time when the user's email address was verified, in ISO 8601 format.
phoneNumber *: string
The user's phone number.
username *: string
The username used to authenticate the user.
enabled *: boolean
Whether the feature or resource is currently enabled.
deleted *: boolean
Whether the resource has been marked as deleted.
idprovider_id *: string
The unique identifier of the identity provider.
organization *: object
The organization that owns the resource.
properties *: object
Additional properties associated with the resource.
Examples
application/json
{ "id": "5197cdf3-36c9-4bcb-8840-5779e961c746", "createdAt": "2015-01-29T00:00:53.315000+00:00", "updatedAt": "2015-01-29T00:00:55.163000+00:00", "lastLogin": "2015-01-29T00:11:55.163000+00:00", "previousLastLogin": "2015-01-28T00:11:55.163000+00:00", "firstName": "Organization", "lastName": "Owner", "ipAllowlistExcluded": false, "email": "core_services@mulesoft.com", "email_verified_at": "2015-01-29T00:00:53.315000+00:00", "phoneNumber": "111-111-1111", "username": "max", "enabled": true, "deleted": false, "idprovider_id": "mulesoft", "organization": { "name": "MuleSoft Inc", "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "createdAt": "2015-02-03T00:20:06.125000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "updatedAt": "2015-02-03T00:20:06.205000+00:00", "clientId": "1e4ea687b8794c679fe325b2e3550a17", "domain": "mulesoft-inc", "idprovider_id": "mulesoft", "properties": { "defaultAccessManagementUi": "cs-ui" }, "entitlements": { "createSubOrgs": false, "createEnvironments": false, "hybrid": { "enabled": false }, "hybridInsight": false, "hybridAutoDiscoverProperties": true, "globalDeployment": false, "vCoresProduction": { "assigned": 1, "reassigned": 0 }, "vCoresSandbox": { "assigned": 1, "reassigned": 0 }, "vCoresDesign": { "assigned": 1, "reassigned": 0 }, "staticIps": { "assigned": 1, "reassigned": 0 }, "vpcs": { "assigned": 0, "reassigned": 0 }, "vpns": { "assigned": 0, "reassigned": 0 }, "networkConnections": { "assigned": 0, "reassigned": 0 }, "workerLoggingOverride": { "enabled": false }, "messaging": { "assigned": 0 }, "mqMessages": { "base": 0, "addOn": 0 }, "mqRequests": { "base": 0, "addOn": 0 }, "mqAdvancedFeatures": { "enabled": false }, "objectStoreRequestUnits": { "base": 0, "addOn": 0 }, "objectStoreKeys": { "base": 0, "addOn": 0 }, "gateways": { "assigned": 0 }, "designCenter": { "mozart": true, "api": true, "apiVisual": false, "apiExample": false }, "partnersProduction": { "assigned": 0 }, "partnersSandbox": { "assigned": 0 }, "tradingPartnersProduction": { "assigned": 0 }, "tradingPartnersSandbox": { "assigned": 0 }, "loadBalancer": { "assigned": 1, "reassigned": 0 }, "externalIdentity": true, "autoscaling": false, "armAlerts": false, "apis": { "enabled": true }, "apiCatalog": { "enabled": false }, "apiMonitoring": { "schedules": 0 }, "apiCommunityManager": { "enabled": false }, "apiExperienceHub": { "enabled": false }, "monitoringCenter": { "productSKU": 3, "rawStorageOverrideGB": 0, "dataRegion": "us-east-1", "productionUnits": 0, "preProductionUnits": 0, "storageBase": 0, "storageAddOn": 0 }, "apiQuery": { "enabled": false, "productSKU": 1 }, "apiQueryC360": { "enabled": false }, "rpa": { "enabled": false, "active": false, "composerVersion": "" }, "idp": { "enabled": false }, "AutomationCreditsDW": { "assigned": 0 }, "apiGovernance": { "enabled": true, "apisPerMonth": 5 }, "apiGovernanceDomain": { "domain": "ASSET" }, "crowd": { "hideApiManagerDesigner": false, "hideFormerApiPlatform": false, "environments": false }, "cam": { "enabled": false }, "exchange2": { "enabled": false, "assetUsageAndEngagement": { "enabled": false } }, "crowdSelfServiceMigration": { "enabled": false }, "kpiDashboard": { "enabled": false }, "pcf": false, "appViz": false, "workerClouds": { "assigned": 0, "reassigned": 0 }, "runtimeFabric": false, "runtimeFabricCloud": { "enabled": false }, "serviceMesh": { "enabled": false }, "flexGateway": { "enabled": false }, "managedGatewaySmall": { "assigned": 0, "reassigned": 0 }, "managedGatewayLarge": { "assigned": 0, "reassigned": 0 }, "rtfManagedGateway": { "enabled": false }, "composer": { "enabled": false, "tasksPerMonth": 100, "maxConnectors": 3, "unlimitedConnectors": false, "isHyperAutomation": false }, "muleDxWebIde": { "enabled": false }, "muleDxGenAI": { "enabled": false }, "muleDxEDA": { "enabled": false }, "usageBasedPricing": { "muleRuntimeIntegration": { "enabled": true, "flows": 100, "messages": 10000, "throughput": 10000000 } }, "usageBasedPricingLimits": { "cpu": { "base": 10.01, "extra": 0.01 }, "memory": { "base": 1.02, "extra": 20.01 } }, "highAvailability": { "clustering": false }, "cloudhub1": { "enabled": true }, "telemetryExporter": { "enabled": true } }, "isFederated": false, "isRoot": true, "isMaster": true, "parentOrganizationIds": [], "subOrganizationIds": [], "tenantOrganizationIds": [], "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" } }, "properties": {} }

Create Signup Existing User createSignupExistingUser

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Get information about signing up (accepting an invite) with an existing user

Request Body

json
username *: string
The username used to authenticate the user.
password *: string
The user's password. Write-only.
Examples
application/json
{ "username": "max", "password": "Password1" }

Response

json
Success
id *: string
The unique identifier of the resource.
createdAt *: string
The date and time when the resource was created, in ISO 8601 format.
updatedAt *: string
The date and time when the resource was last updated, in ISO 8601 format.
firstName *: string
The user's first name.
lastName *: string
The user's last name.
email *: string(email)
The user's email address.
phoneNumber *: string
The user's phone number.
username *: string
The username used to authenticate the user.
enabled *: boolean
Whether the feature or resource is currently enabled.
deleted *: boolean
Whether the resource has been marked as deleted.
idprovider_id *: string
The unique identifier of the identity provider.
organization *: object
The organization that owns the resource.
properties *: object
Additional properties associated with the resource.
attachmentType *: string
The kind of attachment associated with the resource.
Examples
application/json
{ "id": "5197cdf3-36c9-4bcb-8840-5779e961c746", "createdAt": "2015-01-29T00:00:53.315000+00:00", "updatedAt": "2015-01-29T00:00:55.163000+00:00", "firstName": "Organization", "lastName": "Owner", "email": "core_services@mulesoft.com", "phoneNumber": "111-111-1111", "username": "max", "enabled": true, "deleted": false, "idprovider_id": "mulesoft", "organization": { "name": "MuleSoft Inc", "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "createdAt": "2015-02-03T00:20:06.125000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "updatedAt": "2015-02-03T00:20:06.205000+00:00", "clientId": "1e4ea687b8794c679fe325b2e3550a17", "domain": "mulesoft-inc", "idprovider_id": "mulesoft", "properties": { "defaultAccessManagementUi": "cs-ui" }, "entitlements": { "createSubOrgs": false, "createEnvironments": false, "hybrid": { "enabled": false }, "hybridInsight": false, "globalDeployment": false, "vCoresProduction": { "assigned": 1, "reassigned": 0 }, "vCoresSandbox": { "assigned": 1, "reassigned": 0 }, "vCoresDesign": { "assigned": 1, "reassigned": 0 }, "staticIps": { "assigned": 1, "reassigned": 0 }, "vpcs": { "assigned": 0, "reassigned": 0 }, "workerLoggingOverride": { "enabled": false }, "messaging": { "assigned": 0 }, "mqMessages": { "base": 0, "addOn": 0 }, "mqRequests": { "base": 0, "addOn": 0 }, "mqAdvancedFeatures": { "enabled": false }, "objectStoreRequestUnits": { "base": 0, "addOn": 0 }, "objectStoreKeys": { "base": 0, "addOn": 0 }, "gateways": { "assigned": 0 }, "designCenter": { "mozart": true, "api": true, "apiVisual": false, "apiExample": false }, "partnersProduction": { "assigned": 0 }, "partnersSandbox": { "assigned": 0 }, "loadBalancer": { "assigned": 1, "reassigned": 0 }, "externalIdentity": true, "autoscaling": false, "armAlerts": false, "apis": { "enabled": true }, "apiCatalog": { "enabled": false }, "apiMonitoring": { "schedules": 0 }, "apiCommunityManager": { "enabled": false }, "monitoringCenter": { "productSKU": 3, "rawStorageOverrideGB": 0, "dataRegion": "us-east-1", "productionUnits": 0, "preProductionUnits": 0, "storageBase": 0, "storageAddOn": 0 }, "apiQuery": { "enabled": false, "productSKU": 1 }, "apiQueryC360": { "enabled": false }, "rpa": { "enabled": false, "active": false, "composerVersion": "" }, "idp": { "enabled": false }, "AutomationCreditsDW": { "assigned": 0 }, "angGovernance": { "level": -1 }, "apiGovernance": { "enabled": true, "apisPerMonth": 0 }, "apiGovernanceDomain": { "domain": "ASSET" }, "crowd": { "hideApiManagerDesigner": false, "hideFormerApiPlatform": false, "environments": false }, "cam": { "enabled": false }, "exchange2": { "enabled": false, "assetUsageAndEngagement": { "enabled": false } }, "crowdSelfServiceMigration": { "enabled": false }, "kpiDashboard": { "enabled": false }, "pcf": false, "appViz": false, "workerClouds": { "assigned": 0, "reassigned": 0 }, "runtimeFabric": false, "runtimeFabricCloud": { "enabled": false }, "serviceMesh": { "enabled": false }, "flexGateway": { "enabled": false }, "managedGatewaySmall": { "assigned": 0, "reassigned": 0 }, "managedGatewayLarge": { "assigned": 0, "reassigned": 0 }, "rtfManagedGateway": { "enabled": false }, "composer": { "enabled": false, "tasksPerMonth": 100, "maxConnectors": 3, "unlimitedConnectors": false, "isHyperAutomation": false }, "muleDxWebIde": { "enabled": false }, "muleDxGenAI": { "enabled": false }, "muleDxEDA": { "enabled": false }, "cloudhub1": { "enabled": true }, "telemetryExporter": { "enabled": true } }, "isFederated": false, "isRoot": true, "isMaster": true, "parentOrganizationIds": [], "subOrganizationIds": [], "tenantOrganizationIds": [], "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" } }, "properties": {}, "attachmentType": "onlyUser" }

List Status listStatus

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Retrieves the health of the application.

Query Parameters

db *: boolean
replicas *: boolean
arc *: boolean
keys *: boolean
ld *: boolean
all *: boolean

Response

json
Everything is working ok.
status *: string
The current status of the resource.
Examples
application/json
{ "status": "ok" }

List Subscriptions listSubscriptions

GET

Try it out

Custom Query Parameters
Custom Headers
Retrieve the subscriptions supported

Response

Success
Examples
application/json
{ "Developer": [ { "name": "Free", "description": "Expired trial" }, { "name": "Trial", "description": "Trial" } ], "Customer": [ { "name": "Base", "description": "Customer on Base platform without Platinum" }, { "name": "Enterprise", "description": "Customer on old SKUs with Enterprise Subscription" } ] }

List Support listSupport

GET

Try it out

Custom Query Parameters
Custom Headers
Redirect to the support portal or the getting help documentation

Response

Location header contains the link to sso into the support portal, the link to the getting help documentation or (if not signed in) the signin page

Get Username getUsername

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Check if the username is already taken

Path Parameters

username *: string
Username to search

Response

Username exists

List All Users listAllUsers

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Returns a group of users

Query Parameters

deleted *: boolean
type *: string
mfaVerificationExcluded *: boolean
Specify if you want to retrieve only users with a given mfaVerificationExcluded value

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "id": "4b353f44-6486-42ae-ae77-18b4032f9643", "username": "uzer1-test", "firstName": "Uzer", "lastName": "1", "email": "api.platform.qa+uzer@gmail.com", "email_verified_at": null, "enabled": true, "idprovider_id": "mulesoft", "type": "host", "createdAt": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "updatedAt": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "lastLogin": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organization": { "name": "MuleSoft Inc", "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "createdAt": "2015-02-03T00:20:06.125000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "updatedAt": "2015-02-03T00:20:06.205000+00:00", "clientId": "1e4ea687b8794c679fe325b2e3550a17", "domain": "mulesoft-inc", "idprovider_id": "mulesoft", "properties": { "defaultAccessManagementUi": "cs-ui" }, "entitlements": { "createSubOrgs": false, "createEnvironments": false, "hybrid": { "enabled": false }, "hybridInsight": false, "hybridAutoDiscoverProperties": true, "globalDeployment": false, "vCoresProduction": { "assigned": 1, "reassigned": 0 }, "vCoresSandbox": { "assigned": 1, "reassigned": 0 }, "vCoresDesign": { "assigned": 1, "reassigned": 0 }, "staticIps": { "assigned": 1, "reassigned": 0 }, "vpcs": { "assigned": 0, "reassigned": 0 }, "vpns": { "assigned": 0, "reassigned": 0 }, "networkConnections": { "assigned": 0, "reassigned": 0 }, "workerLoggingOverride": { "enabled": false }, "messaging": { "assigned": 0 }, "mqMessages": { "base": 0, "addOn": 0 }, "mqRequests": { "base": 0, "addOn": 0 }, "mqAdvancedFeatures": { "enabled": false }, "objectStoreRequestUnits": { "base": 0, "addOn": 0 }, "objectStoreKeys": { "base": 0, "addOn": 0 }, "gateways": { "assigned": 0 }, "designCenter": { "mozart": true, "api": true, "apiVisual": false, "apiExample": false }, "partnersProduction": { "assigned": 0 }, "partnersSandbox": { "assigned": 0 }, "tradingPartnersProduction": { "assigned": 0 }, "tradingPartnersSandbox": { "assigned": 0 }, "loadBalancer": { "assigned": 0, "reassigned": 0 }, "externalIdentity": true, "autoscaling": false, "armAlerts": false, "apis": { "enabled": true }, "apiCatalog": { "enabled": false }, "apiMonitoring": { "schedules": 0 }, "apiCommunityManager": { "enabled": false }, "apiExperienceHub": { "enabled": false }, "monitoringCenter": { "productSKU": 3, "rawStorageOverrideGB": 0, "dataRegion": "us-east-1", "productionUnits": 0, "preProductionUnits": 0, "storageBase": 0, "storageAddOn": 0 }, "apiQuery": { "enabled": false, "productSKU": 1 }, "apiQueryC360": { "enabled": false }, "rpa": { "enabled": false, "active": false, "composerVersion": "" }, "idp": { "enabled": false }, "AutomationCreditsDW": { "assigned": 0 }, "apiGovernance": { "enabled": true, "apisPerMonth": 5 }, "apiGovernanceDomain": { "domain": "ASSET" }, "crowd": { "hideApiManagerDesigner": false, "hideFormerApiPlatform": false, "environments": false }, "cam": { "enabled": false }, "exchange2": { "enabled": false, "assetUsageAndEngagement": { "enabled": false } }, "crowdSelfServiceMigration": { "enabled": false }, "kpiDashboard": { "enabled": false }, "pcf": false, "appViz": false, "workerClouds": { "assigned": 0, "reassigned": 0 }, "runtimeFabric": false, "runtimeFabricCloud": { "enabled": false }, "serviceMesh": { "enabled": false }, "flexGateway": { "enabled": false }, "managedGatewaySmall": { "assigned": 0, "reassigned": 0 }, "managedGatewayLarge": { "assigned": 0, "reassigned": 0 }, "rtfManagedGateway": { "enabled": false }, "composer": { "enabled": false, "tasksPerMonth": 100, "maxConnectors": 3, "unlimitedConnectors": false, "isHyperAutomation": false }, "muleDxWebIde": { "enabled": false }, "muleDxGenAI": { "enabled": false }, "muleDxEDA": { "enabled": false }, "usageBasedPricing": { "muleRuntimeIntegration": { "enabled": true, "flows": 100, "messages": 10000, "throughput": 10000000 } }, "usageBasedPricingLimits": { "cpu": { "base": 10.01, "extra": 0.01 }, "memory": { "base": 1.02, "extra": 20.01 } }, "highAvailability": { "clustering": false }, "cloudhub1": { "enabled": true }, "telemetryExporter": { "enabled": true } }, "isFederated": false, "isRoot": true, "isMaster": true, "parentOrganizationIds": [], "subOrganizationIds": [], "tenantOrganizationIds": [], "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" } }, "isApiConsumer": false } ], "total": 1 }

Create User createUser

POST

Try it out

Custom Query Parameters
Custom Headers
Creates new users

Response

Success

Update All Users updateAllUsers

PUT

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Update a group of users

Request Body

json
items: array
Request payload for Generated12.
Examples
application/json
[ { "id": "fe340288-9c90-4995-bf26-c6cbf45f16d5", "firstName": "Juan", "lastName": "Ferrer", "email": "jferrer@example.com", "phoneNumber": "111-111-1111", "enabled": true }, { "id": "03645ba9-80fd-4d5a-81a7-cec39272b8c2", "firstName": "John", "lastName": "Smith", "email": "jsmith@example.com", "phoneNumber": "222-222-2222", "enabled": true } ]

Response

Success

Delete All Users deleteAllUsers

DELETE

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Delete a group of users

Request Body

json
items: array
Request payload for Generated10.
Examples
application/json
[ "1c0d1a43-4d91-4b52-bcc6-cff8ecf0c3a3", "dc52bf66-b0d8-4cda-9ae8-45a5f085ead4", "5314c476-1cd4-49be-ba4e-1d67f6c052c3" ]

Response

Success

Get User By Id getUserById

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a single user

Path Parameters

userId *: string

Response

json
Success
id *: string
The unique identifier of the resource.
createdAt *: string
The date and time when the resource was created, in ISO 8601 format.
updatedAt *: string
The date and time when the resource was last updated, in ISO 8601 format.
lastLogin *: string
The date and time of the user's most recent successful login, in ISO 8601 format.
previousLastLogin *: string
The date and time of the user's previous successful login, in ISO 8601 format.
firstName *: string
The user's first name.
lastName *: string
The user's last name.
ipAllowlistExcluded *: boolean
Whether the resource is excluded from organization-level IP allowlist enforcement.
email *: string(email)
The user's email address.
email_verified_at *: string
The date and time when the user's email address was verified, in ISO 8601 format.
phoneNumber *: string
The user's phone number.
username *: string
The username used to authenticate the user.
enabled *: boolean
Whether the feature or resource is currently enabled.
deleted *: boolean
Whether the resource has been marked as deleted.
idprovider_id *: string
The unique identifier of the identity provider.
organization *: object
The organization that owns the resource.
properties *: object
Additional properties associated with the resource.
Examples
application/json
{ "id": "5197cdf3-36c9-4bcb-8840-5779e961c746", "createdAt": "2015-01-29T00:00:53.315000+00:00", "updatedAt": "2015-01-29T00:00:55.163000+00:00", "lastLogin": "2015-01-29T00:11:55.163000+00:00", "previousLastLogin": "2015-01-28T00:11:55.163000+00:00", "firstName": "Organization", "lastName": "Owner", "ipAllowlistExcluded": false, "email": "core_services@mulesoft.com", "email_verified_at": "2015-01-29T00:00:53.315000+00:00", "phoneNumber": "111-111-1111", "username": "max", "enabled": true, "deleted": false, "idprovider_id": "mulesoft", "organization": { "name": "MuleSoft Inc", "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "createdAt": "2015-02-03T00:20:06.125000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "updatedAt": "2015-02-03T00:20:06.205000+00:00", "clientId": "1e4ea687b8794c679fe325b2e3550a17", "domain": "mulesoft-inc", "idprovider_id": "mulesoft", "properties": { "defaultAccessManagementUi": "cs-ui" }, "entitlements": { "createSubOrgs": false, "createEnvironments": false, "hybrid": { "enabled": false }, "hybridInsight": false, "hybridAutoDiscoverProperties": true, "globalDeployment": false, "vCoresProduction": { "assigned": 1, "reassigned": 0 }, "vCoresSandbox": { "assigned": 1, "reassigned": 0 }, "vCoresDesign": { "assigned": 1, "reassigned": 0 }, "staticIps": { "assigned": 1, "reassigned": 0 }, "vpcs": { "assigned": 0, "reassigned": 0 }, "vpns": { "assigned": 0, "reassigned": 0 }, "networkConnections": { "assigned": 0, "reassigned": 0 }, "workerLoggingOverride": { "enabled": false }, "messaging": { "assigned": 0 }, "mqMessages": { "base": 0, "addOn": 0 }, "mqRequests": { "base": 0, "addOn": 0 }, "mqAdvancedFeatures": { "enabled": false }, "objectStoreRequestUnits": { "base": 0, "addOn": 0 }, "objectStoreKeys": { "base": 0, "addOn": 0 }, "gateways": { "assigned": 0 }, "designCenter": { "mozart": true, "api": true, "apiVisual": false, "apiExample": false }, "partnersProduction": { "assigned": 0 }, "partnersSandbox": { "assigned": 0 }, "tradingPartnersProduction": { "assigned": 0 }, "tradingPartnersSandbox": { "assigned": 0 }, "loadBalancer": { "assigned": 1, "reassigned": 0 }, "externalIdentity": true, "autoscaling": false, "armAlerts": false, "apis": { "enabled": true }, "apiCatalog": { "enabled": false }, "apiMonitoring": { "schedules": 0 }, "apiCommunityManager": { "enabled": false }, "apiExperienceHub": { "enabled": false }, "monitoringCenter": { "productSKU": 3, "rawStorageOverrideGB": 0, "dataRegion": "us-east-1", "productionUnits": 0, "preProductionUnits": 0, "storageBase": 0, "storageAddOn": 0 }, "apiQuery": { "enabled": false, "productSKU": 1 }, "apiQueryC360": { "enabled": false }, "rpa": { "enabled": false, "active": false, "composerVersion": "" }, "idp": { "enabled": false }, "AutomationCreditsDW": { "assigned": 0 }, "apiGovernance": { "enabled": true, "apisPerMonth": 5 }, "apiGovernanceDomain": { "domain": "ASSET" }, "crowd": { "hideApiManagerDesigner": false, "hideFormerApiPlatform": false, "environments": false }, "cam": { "enabled": false }, "exchange2": { "enabled": false, "assetUsageAndEngagement": { "enabled": false } }, "crowdSelfServiceMigration": { "enabled": false }, "kpiDashboard": { "enabled": false }, "pcf": false, "appViz": false, "workerClouds": { "assigned": 0, "reassigned": 0 }, "runtimeFabric": false, "runtimeFabricCloud": { "enabled": false }, "serviceMesh": { "enabled": false }, "flexGateway": { "enabled": false }, "managedGatewaySmall": { "assigned": 0, "reassigned": 0 }, "managedGatewayLarge": { "assigned": 0, "reassigned": 0 }, "rtfManagedGateway": { "enabled": false }, "composer": { "enabled": false, "tasksPerMonth": 100, "maxConnectors": 3, "unlimitedConnectors": false, "isHyperAutomation": false }, "muleDxWebIde": { "enabled": false }, "muleDxGenAI": { "enabled": false }, "muleDxEDA": { "enabled": false }, "usageBasedPricing": { "muleRuntimeIntegration": { "enabled": true, "flows": 100, "messages": 10000, "throughput": 10000000 } }, "usageBasedPricingLimits": { "cpu": { "base": 10.01, "extra": 0.01 }, "memory": { "base": 1.02, "extra": 20.01 } }, "highAvailability": { "clustering": false }, "cloudhub1": { "enabled": true }, "telemetryExporter": { "enabled": true } }, "isFederated": false, "isRoot": true, "isMaster": true, "parentOrganizationIds": [], "subOrganizationIds": [], "tenantOrganizationIds": [], "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" } }, "properties": {} }

Update User By Id updateUserById

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a single user. Modifying email may require reauthentication.

Path Parameters

userId *: string

Request Body

json
firstName *: string
The user's first name.
lastName *: string
The user's last name.
ipAllowlistExcluded *: boolean
Whether the resource is excluded from organization-level IP allowlist enforcement.
email *: string(email)
The user's email address.
phoneNumber *: string
The user's phone number.
enabled *: boolean
Whether the feature or resource is currently enabled.
properties *: object
Additional properties associated with the resource.
Examples
application/json
{ "firstName": "Juan", "lastName": "Ferrer", "ipAllowlistExcluded": true, "email": "jferrer@mulesoft.com", "phoneNumber": "111-111-1111", "enabled": true, "properties": { "cs_auth": { "country": "Argentina" } } }

Response

Success

Delete User By Id deleteUserById

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes a user

Path Parameters

userId *: string

Response

Success

Create Users Banpassword createUsersBanpassword

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Ban a user's password such that no new users can set that as their password ever again. When the user logs in with the banned password, they will be taken through the reset password flow

Path Parameters

userId *: string

Response

Success

Update User Properties updateUserProperties

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update the properties of a user

Path Parameters

userId *: string

Request Body

json
cs_auth *: object
Configuration for Anypoint Platform authentication settings.
Examples
application/json
{ "cs_auth": { "activeOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043" } }

Response

json
Success
cs_auth *: object
Configuration for Anypoint Platform authentication settings.
Examples
application/json
{ "cs_auth": { "activeOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043" } }

List All User Roles listAllUserRoles

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of roles assigned to the user

Path Parameters

userId *: string

Query Parameters

namepace: string
return only role assignments where a role contains a permission that is part of the given namespace
role_groups: boolean
get user roles from role_groups
teams: boolean
get team roles from team_role_assignments

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "role_id": "73a5c3c3-ef75-4291-b51e-a69f998eeea2", "context_params": { "org": "a248f5de-70c3-480e-a35f-35cee4d91c5d" }, "name": "Organization Owner", "description": "Organization Owner allows full administration of users and full access to create and manage all APIs" }, { "role_id": "96bf8032-9e54-4031-9bee-bc5f59f9f4e5", "context_params": { "org": "a248f5de-70c3-480e-a35f-35cee4d91c5d", "user": "6c611d76-8f9c-40be-86dd-e73458ad6b0c" }, "name": "Business Group Viewer", "description": "Business Group Viewer" } ], "total": 2 }

Add Role To User addRoleToUser

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Assign a role to the user

Path Parameters

userId *: string
roleId *: string

Response

Success

Remove Role From User removeRoleFromUser

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Unassign a role from the user

Path Parameters

userId *: string
roleId *: string

Response

Success

List Users Me listUsersMe

GET

Try it out

Custom Query Parameters
Custom Headers
Returns the user bound to the provided access token

Response

json
Success
id *: string
The unique identifier of the resource.
createdAt *: string
The date and time when the resource was created, in ISO 8601 format.
updatedAt *: string
The date and time when the resource was last updated, in ISO 8601 format.
lastLogin *: string
The date and time of the user's most recent successful login, in ISO 8601 format.
previousLastLogin *: string
The date and time of the user's previous successful login, in ISO 8601 format.
firstName *: string
The user's first name.
lastName *: string
The user's last name.
ipAllowlistExcluded *: boolean
Whether the resource is excluded from organization-level IP allowlist enforcement.
email *: string(email)
The user's email address.
email_verified_at *: string
The date and time when the user's email address was verified, in ISO 8601 format.
phoneNumber *: string
The user's phone number.
username *: string
The username used to authenticate the user.
enabled *: boolean
Whether the feature or resource is currently enabled.
deleted *: boolean
Whether the resource has been marked as deleted.
idprovider_id *: string
The unique identifier of the identity provider.
organization *: object
The organization that owns the resource.
properties *: object
Additional properties associated with the resource.
Examples
application/json
{ "id": "5197cdf3-36c9-4bcb-8840-5779e961c746", "createdAt": "2015-01-29T00:00:53.315000+00:00", "updatedAt": "2015-01-29T00:00:55.163000+00:00", "lastLogin": "2015-01-29T00:11:55.163000+00:00", "previousLastLogin": "2015-01-28T00:11:55.163000+00:00", "firstName": "Organization", "lastName": "Owner", "ipAllowlistExcluded": false, "email": "core_services@mulesoft.com", "email_verified_at": "2015-01-29T00:00:53.315000+00:00", "phoneNumber": "111-111-1111", "username": "max", "enabled": true, "deleted": false, "idprovider_id": "mulesoft", "organization": { "name": "MuleSoft Inc", "id": "f0c9b011-980e-4928-9430-e60e3a97c043", "createdAt": "2015-02-03T00:20:06.125000+00:00", "ownerId": "57e281b5-ec5b-4701-80a0-92a936a68da3", "updatedAt": "2015-02-03T00:20:06.205000+00:00", "clientId": "1e4ea687b8794c679fe325b2e3550a17", "domain": "mulesoft-inc", "idprovider_id": "mulesoft", "properties": { "defaultAccessManagementUi": "cs-ui" }, "entitlements": { "createSubOrgs": false, "createEnvironments": false, "hybrid": { "enabled": false }, "hybridInsight": false, "hybridAutoDiscoverProperties": true, "globalDeployment": false, "vCoresProduction": { "assigned": 1, "reassigned": 0 }, "vCoresSandbox": { "assigned": 1, "reassigned": 0 }, "vCoresDesign": { "assigned": 1, "reassigned": 0 }, "staticIps": { "assigned": 1, "reassigned": 0 }, "vpcs": { "assigned": 0, "reassigned": 0 }, "vpns": { "assigned": 0, "reassigned": 0 }, "networkConnections": { "assigned": 0, "reassigned": 0 }, "workerLoggingOverride": { "enabled": false }, "messaging": { "assigned": 0 }, "mqMessages": { "base": 0, "addOn": 0 }, "mqRequests": { "base": 0, "addOn": 0 }, "mqAdvancedFeatures": { "enabled": false }, "objectStoreRequestUnits": { "base": 0, "addOn": 0 }, "objectStoreKeys": { "base": 0, "addOn": 0 }, "gateways": { "assigned": 0 }, "designCenter": { "mozart": true, "api": true, "apiVisual": false, "apiExample": false }, "partnersProduction": { "assigned": 0 }, "partnersSandbox": { "assigned": 0 }, "tradingPartnersProduction": { "assigned": 0 }, "tradingPartnersSandbox": { "assigned": 0 }, "loadBalancer": { "assigned": 1, "reassigned": 0 }, "externalIdentity": true, "autoscaling": false, "armAlerts": false, "apis": { "enabled": true }, "apiCatalog": { "enabled": false }, "apiMonitoring": { "schedules": 0 }, "apiCommunityManager": { "enabled": false }, "apiExperienceHub": { "enabled": false }, "monitoringCenter": { "productSKU": 3, "rawStorageOverrideGB": 0, "dataRegion": "us-east-1", "productionUnits": 0, "preProductionUnits": 0, "storageBase": 0, "storageAddOn": 0 }, "apiQuery": { "enabled": false, "productSKU": 1 }, "apiQueryC360": { "enabled": false }, "rpa": { "enabled": false, "active": false, "composerVersion": "" }, "idp": { "enabled": false }, "AutomationCreditsDW": { "assigned": 0 }, "apiGovernance": { "enabled": true, "apisPerMonth": 5 }, "apiGovernanceDomain": { "domain": "ASSET" }, "crowd": { "hideApiManagerDesigner": false, "hideFormerApiPlatform": false, "environments": false }, "cam": { "enabled": false }, "exchange2": { "enabled": false, "assetUsageAndEngagement": { "enabled": false } }, "crowdSelfServiceMigration": { "enabled": false }, "kpiDashboard": { "enabled": false }, "pcf": false, "appViz": false, "workerClouds": { "assigned": 0, "reassigned": 0 }, "runtimeFabric": false, "runtimeFabricCloud": { "enabled": false }, "serviceMesh": { "enabled": false }, "flexGateway": { "enabled": false }, "managedGatewaySmall": { "assigned": 0, "reassigned": 0 }, "managedGatewayLarge": { "assigned": 0, "reassigned": 0 }, "rtfManagedGateway": { "enabled": false }, "composer": { "enabled": false, "tasksPerMonth": 100, "maxConnectors": 3, "unlimitedConnectors": false, "isHyperAutomation": false }, "muleDxWebIde": { "enabled": false }, "muleDxGenAI": { "enabled": false }, "muleDxEDA": { "enabled": false }, "usageBasedPricing": { "muleRuntimeIntegration": { "enabled": true, "flows": 100, "messages": 10000, "throughput": 10000000 } }, "usageBasedPricingLimits": { "cpu": { "base": 10.01, "extra": 0.01 }, "memory": { "base": 1.02, "extra": 20.01 } }, "highAvailability": { "clustering": false }, "cloudhub1": { "enabled": true }, "telemetryExporter": { "enabled": true } }, "isFederated": false, "isRoot": true, "isMaster": true, "parentOrganizationIds": [], "subOrganizationIds": [], "tenantOrganizationIds": [], "subscription": { "category": "Developer", "type": "Free", "expiration": "2014-07-27T20:56:02.125000+00:00" } }, "properties": {} }

List Version listVersion

GET

Try it out

Custom Query Parameters
Custom Headers
Retrieve the version info for the application

Response

json
Success
branch *: string
The source-control branch associated with the resource.
tag *: string
The source-control tag associated with the resource.
short *: string
The short form of the value.
long *: string
The long form of the value.
environment *: string
The environment associated with the resource.
Examples
application/json
{ "branch": "HEAD", "tag": "0.3.8-alpha.2", "short": "72fe9aa", "long": "72fe9aadcdeec52ef117a0abe6473329ad31cad3", "environment": "production" }

List V2Oauth2Authorize listV2Oauth2Authorize

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Starts an OAuth2 authorization flow; allows the logged-in user to authorize 3rd-party access to their data

Query Parameters

client_id: string
The ID of the application attempting to be authorized
scope: string
Space-delimited list of scopes the client is requesting
state: string
a parameter with a string that will be supplied in a redirect back to the application upon success
redirect_uri: string
Redirect uri for the application's authorization callback
response_type: string
describes the type of object that the application wishes to receive upon success
nonce: string
value used to mitigate replay attacks

Response

Redirects the user agent to the application's callback URI if the application is already authorized
Redirects the user agent to the consent screen otherwise

Create V2Oauth2Authorize createV2Oauth2Authorize

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/x-www-form-urlencoded
Starts an OAuth2 authorization flow; allows the logged-in user to authorize 3rd-party access to their data

Request Body

x-www-form-urlencoded
client_id: string
The ID of the application attempting to be authorized
scope: string
Space-delimited list of scopes the client is requesting
state: string
a parameter with a string that will be supplied in a redirect back to the application upon success
redirect_uri: string
Redirect uri for the application's authorization callback
response_type: string
describes the type of object that the application wishes to receive upon success
nonce: string
value used to mitigate replay attacks

Response

Redirects the user to the application's callback URI if the application is already authorized
Redirects the user to the consent screen otherwise

List V2Oauth2Authorize By Domain listV2Oauth2AuthorizeByDomain

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Starts an OAuth2 authorization flow; allows the logged-in user to authorize 3rd-party access to their data

Path Parameters

domain *: string
Domain name to identify the organization to identify what identity management system needs to authentication the user.

Query Parameters

nonce: string
value used to mitigate replay attacks
state: string
a parameter with a string that will be supplied in a redirect back to the application upon success
scope: string
Space-delimited list of scopes the client is requesting
redirect_uri: string
Redirect uri for the application's authorization callback
client_id: string
The ID of the application attempting to be authorized
response_type: string
describes the type of object that the application wishes to receive upon success

Response

Redirects the user agent to the application's callback URI if the application is already authorized
Redirects the user agent to the consent screen otherwise

Create V2Oauth2Authorize By Domain createV2Oauth2AuthorizeByDomain

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/x-www-form-urlencoded
Starts an OAuth2 authorization flow; allows the logged-in user to authorize 3rd-party access to their data

Path Parameters

domain *: string
Domain name to identify the organization to identify what identity management system needs to authentication the user.

Request Body

x-www-form-urlencoded
client_id: string
The ID of the application attempting to be authorized
scope: string
Space-delimited list of scopes the client is requesting
state: string
a parameter with a string that will be supplied in a redirect back to the application upon success
redirect_uri: string
Redirect uri for the application's authorization callback
response_type: string
describes the type of object that the application wishes to receive upon success
nonce: string
value used to mitigate replay attacks

Response

Redirects the user to the application's callback URI if the application is already authorized
Redirects the user to the consent screen otherwise

Create V2Oauth2Decision createV2Oauth2Decision

POST

Try it out

Custom Query Parameters
Custom Headers
Confirms whether a user grants consent to a 3rd-party application

Response

Redirects the user to the application's callback URI

Create V2Oauth2Token createV2Oauth2Token

POST

Try it out

Custom Query Parameters
Custom Headers
Allows 3rd-party applications to receive tokens via a variety of supported grant types

Response

List V2Oauth2Keys listV2Oauth2Keys

GET

Try it out

Custom Query Parameters
Custom Headers
Public JWK Set used to sign OpenID Connect id_tokens

Response

A JWK Set containing one or more JWK-formatted keys.
For more information about the JWK format, see RFC-7517
For more information about the use of JWKs in OpenID Connect, see the OpenID Connect Core 1.0 spec

Get Openid Configuration getOpenidConfiguration

GET

Try it out

Custom Query Parameters
Custom Headers
OpenID Connect Discovery Configuration

Response

The service's OpenID Provider Configuration Information metadata document.
For more information about the contents and use of the document, see the OpenID Connect Discovery 1.0 spec

List V2Oauth2Userinfo listV2Oauth2Userinfo

GET

Try it out

Custom Query Parameters
Custom Headers
OpenID Connect Userinfo endpoint.

Response

A set of claims about the authenticated End-User.
For more information about the use of the userinfo endpoint in OpenID Connect, see the OpenID Connect Core 1.0 spec

Create V2Oauth2Userinfo createV2Oauth2Userinfo

POST

Try it out

Custom Query Parameters
Custom Headers
OpenID Connect Userinfo endpoint.

Response

A set of claims about the authenticated End-User.
For more information about the use of the userinfo endpoint in OpenID Connect, see the OpenID Connect Core 1.0 spec

Create V2Oauth2Introspect createV2Oauth2Introspect

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/x-www-form-urlencoded
Introspect an access token or refresh token

Request Body

x-www-form-urlencoded
token *: string
The token to introspect
token_type_hint: string

Response

Create V2Oauth2Revoke createV2Oauth2Revoke

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/x-www-form-urlencoded
Revoke an access token or a refresh token

Request Body

x-www-form-urlencoded
token *: string
The token to revoke
token_type_hint: string

Response

Token was revoked successfully

Get V2Organization getV2Organization

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves details of v2.

Path Parameters

organizationId *: string

Response

Delete V2Organization deleteV2Organization

DELETE

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Deletes an existing v2.

Path Parameters

organizationId *: string

Query Parameters

force: boolean

Response

Success

List V2Einstein Status listV2EinsteinStatus

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get the org-wide Einstein status

Path Parameters

organizationId *: string

Response

json
Success
enabled *: boolean
Whether the feature or resource is currently enabled.
Examples
application/json
{ "enabled": true }

Update V2Einstein Status updateV2EinsteinStatus

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Set the org-wide Einstein status

Path Parameters

organizationId *: string

Request Body

json
enabled *: boolean

Response

Success

List V2Einstein Terms And Conditions listV2EinsteinTermsAndConditions

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get the agreement status for einstein terms and conditions

Path Parameters

organizationId *: string

Response

json
Returns agreement status
status *: string
The current status of the resource.
Examples
application/json
{ "status": "ok" }

Update V2Einstein Terms And Conditions updateV2EinsteinTermsAndConditions

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Toggle the agreement status for einstein terms and conditions

Path Parameters

organizationId *: string

Request Body

json
agree *: boolean

Response

Success

List V2Entitlements listV2Entitlements

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of v2 entitlements.

Path Parameters

organizationId *: string

Response

Return entitlements for this organization
Examples
application/json
{ "hybrid": { "enabled": true }, "createEnvironments": true, "globalDeployment": true, "createSubOrgs": true, "vCoresProduction": { "assigned": 1, "reassigned": 0 }, "vCoresSandbox": { "assigned": 1, "reassigned": 0 }, "vCoresDesign": { "assigned": 1, "reassigned": 0 }, "staticIps": { "assigned": 1, "reassigned": 0 }, "vpcs": { "assigned": 0, "reassigned": 0 }, "vpns": { "assigned": 0, "reassigned": 0 }, "networkConnections": { "assigned": 0, "reassigned": 0 }, "workerLoggingOverride": { "enabled": false }, "messaging": { "assigned": 0 }, "mqMessages": { "base": 0, "addOn": 0 }, "mqRequests": { "base": 0, "addOn": 0 }, "mqAdvancedFeatures": { "enabled": false }, "objectStoreRequestUnits": { "base": 0, "addOn": 0 }, "objectStoreKeys": { "base": 0, "addOn": 0 }, "gateways": { "assigned": 0 }, "designCenter": { "mozart": true, "api": true, "apiVisual": false, "apiExample": false }, "partnersProduction": { "assigned": 0 }, "partnersSandbox": { "assigned": 0 }, "tradingPartnersProduction": { "assigned": 0 }, "tradingPartnersSandbox": { "assigned": 0 }, "loadBalancer": { "assigned": 0, "reassigned": 0 }, "externalIdentity": true, "autoscaling": false, "armAlerts": false, "hybridInsight": true, "hybridAutoDiscoverProperties": true, "apis": { "enabled": true }, "apiCatalog": { "enabled": false }, "apiMonitoring": { "schedules": 0 }, "apiCommunityManager": { "enabled": false }, "apiExperienceHub": { "enabled": false }, "monitoringCenter": { "productSKU": 3, "rawStorageOverrideGB": 0, "dataRegion": "us-east-1", "productionUnits": 0, "preProductionUnits": 0, "storageBase": 0, "storageAddOn": 0 }, "apiQuery": { "enabled": false, "productSKU": 1 }, "apiQueryC360": { "enabled": false }, "rpa": { "enabled": false, "active": false, "composerVersion": "" }, "idp": { "enabled": false }, "AutomationCreditsDW": { "assigned": 0 }, "apiGovernance": { "enabled": true, "apisPerMonth": 5 }, "apiGovernanceDomain": { "domain": "ASSET" }, "crowd": { "hideApiManagerDesigner": false, "hideFormerApiPlatform": false, "environments": false }, "cam": { "enabled": false }, "exchange2": { "enabled": false, "assetUsageAndEngagement": { "enabled": false } }, "crowdSelfServiceMigration": { "enabled": false }, "kpiDashboard": { "enabled": false }, "pcf": false, "appViz": false, "workerClouds": { "assigned": 0, "reassigned": 0 }, "runtimeFabric": false, "serviceMesh": { "enabled": false }, "flexGateway": { "enabled": false }, "managedGatewaySmall": { "assigned": 0, "reassigned": 0 }, "managedGatewayLarge": { "assigned": 0, "reassigned": 0 }, "rtfManagedGateway": { "enabled": false }, "runtimeFabricCloud": { "enabled": false }, "composer": { "enabled": false, "tasksPerMonth": 100, "maxConnectors": 3, "unlimitedConnectors": false, "isHyperAutomation": false }, "muleDxWebIde": { "enabled": false }, "muleDxGenAI": { "enabled": false }, "muleDxEDA": { "enabled": false }, "usageBasedPricing": { "muleRuntimeIntegration": { "enabled": true, "flows": 100, "messages": 10000, "throughput": 10000000 } }, "usageBasedPricingLimits": { "cpu": { "base": 10.01, "extra": 0.01 }, "memory": { "base": 1.02, "extra": 20.01 } }, "highAvailability": { "clustering": false }, "cloudhub1": { "enabled": true }, "telemetryExporter": { "enabled": true } }

Update V2Entitlements updateV2Entitlements

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Sets one or more values for entitlements

Path Parameters

organizationId *: string

Request Body

json

Response

Entitlement has been modified
Examples
application/json
{ "hybrid": { "enabled": true }, "createEnvironments": true, "globalDeployment": true, "createSubOrgs": true, "vCoresProduction": { "assigned": 1, "reassigned": 0 }, "vCoresSandbox": { "assigned": 1, "reassigned": 0 }, "vCoresDesign": { "assigned": 1, "reassigned": 0 }, "staticIps": { "assigned": 1, "reassigned": 0 }, "vpcs": { "assigned": 0, "reassigned": 0 }, "vpns": { "assigned": 0, "reassigned": 0 }, "networkConnections": { "assigned": 0, "reassigned": 0 }, "workerLoggingOverride": { "enabled": false }, "messaging": { "assigned": 0 }, "mqMessages": { "base": 0, "addOn": 0 }, "mqRequests": { "base": 0, "addOn": 0 }, "mqAdvancedFeatures": { "enabled": false }, "objectStoreRequestUnits": { "base": 0, "addOn": 0 }, "objectStoreKeys": { "base": 0, "addOn": 0 }, "gateways": { "assigned": 0 }, "designCenter": { "mozart": true, "api": true, "apiVisual": false, "apiExample": false }, "partnersProduction": { "assigned": 0 }, "partnersSandbox": { "assigned": 0 }, "tradingPartnersProduction": { "assigned": 0 }, "tradingPartnersSandbox": { "assigned": 0 }, "loadBalancer": { "assigned": 0, "reassigned": 0 }, "externalIdentity": true, "autoscaling": false, "armAlerts": false, "hybridInsight": true, "hybridAutoDiscoverProperties": true, "apis": { "enabled": true }, "apiCatalog": { "enabled": false }, "apiMonitoring": { "schedules": 0 }, "apiCommunityManager": { "enabled": false }, "apiExperienceHub": { "enabled": false }, "monitoringCenter": { "productSKU": 3, "rawStorageOverrideGB": 0, "dataRegion": "us-east-1", "productionUnits": 0, "preProductionUnits": 0, "storageBase": 0, "storageAddOn": 0 }, "apiQuery": { "enabled": false, "productSKU": 1 }, "apiQueryC360": { "enabled": false }, "rpa": { "enabled": false, "active": false, "composerVersion": "" }, "idp": { "enabled": false }, "AutomationCreditsDW": { "assigned": 0 }, "apiGovernance": { "enabled": true, "apisPerMonth": 5 }, "apiGovernanceDomain": { "domain": "ASSET" }, "crowd": { "hideApiManagerDesigner": false, "hideFormerApiPlatform": false, "environments": false }, "cam": { "enabled": false }, "exchange2": { "enabled": false, "assetUsageAndEngagement": { "enabled": false } }, "crowdSelfServiceMigration": { "enabled": false }, "kpiDashboard": { "enabled": false }, "pcf": false, "appViz": false, "workerClouds": { "assigned": 0, "reassigned": 0 }, "runtimeFabric": false, "serviceMesh": { "enabled": false }, "flexGateway": { "enabled": false }, "managedGatewaySmall": { "assigned": 0, "reassigned": 0 }, "managedGatewayLarge": { "assigned": 0, "reassigned": 0 }, "rtfManagedGateway": { "enabled": false }, "runtimeFabricCloud": { "enabled": false }, "composer": { "enabled": false, "tasksPerMonth": 100, "maxConnectors": 3, "unlimitedConnectors": false, "isHyperAutomation": false }, "muleDxWebIde": { "enabled": false }, "muleDxGenAI": { "enabled": false }, "muleDxEDA": { "enabled": false }, "usageBasedPricing": { "muleRuntimeIntegration": { "enabled": true, "flows": 100, "messages": 10000, "throughput": 10000000 } }, "usageBasedPricingLimits": { "cpu": { "base": 10.01, "extra": 0.01 }, "memory": { "base": 1.02, "extra": 20.01 } }, "highAvailability": { "clustering": false }, "cloudhub1": { "enabled": true }, "telemetryExporter": { "enabled": true } }

Get V2Entitlements getV2Entitlements

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns the name and value of the specified entitlement

Path Parameters

organizationId *: string
entitlementName *: string
The name of the entitlement

Response

Returns entitlement
Examples
application/json
{ "createEnvironments": true }

Delete V2Environments deleteV2Environments

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete an environment

Path Parameters

organizationId *: string
environmentId *: string

Response

Successful. Returns zero length body

List V2Roles Users listV2RolesUsers

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Retrieve users by roles

Query Parameters

role_groups *: boolean
teams *: boolean

Response

json
Success
data *: array
The list of items returned by the request.
total *: integer
The total number of items available across all pages.
Examples
application/json
{ "data": [ { "id": "d5d309ee-8c23-49e3-bec1-70ee99c42061", "username": "Immanuel1234", "firstName": "Immanuel", "lastName": "Jagerson", "email": "Immanuel@gmail.com", "enabled": true, "idprovider_id": "mulesoft", "type": "host", "createdAt": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "updatedAt": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "lastLogin": "Mon Feb 09 2015 17:47:26 GMT-0300 (ART)", "organizationId": "7f30ff47-5917-4a5a-b94d-9fe029edc04d", "assignments": [ { "role_id": "833ab9ca-0c72-45ba-9764-1df83240db57", "context_params": { "org": "7f30ff47-5917-4a5a-b94d-9fe029edc04d", "user": "d5d309ee-8c23-49e3-bec1-70ee99c42061" }, "created_at": "2019-10-21T11:11:48.204521-07:00" }, { "role_id": "e3284047-6334-4580-b441-53afe7598b6e", "context_params": { "org": "7f30ff47-5917-4a5a-b94d-9fe029edc04d", "envId": "4c4efd56-9232-4f41-bb5c-4990539d519f" }, "created_at": "2019-10-21T11:11:48.204521-07:00" } ] } ], "total": 1 }