Access Management API

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

clientId *

Query Parameters

resetSecret *

Custom Query Parameters

Custom Headers

Request Body application/json

Patches a single client

Path Parameters

clientId *: string

The unique identifier of the client application.

Related Operations:

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

Too many requests

Delete Clients deleteClients

DELETE

Try it out

Path Parameters

clientId *

Custom Query Parameters

Custom Headers

Deletes a single client

Path Parameters

clientId *: string

The unique identifier of the client application.

Related Operations:

Response

Too many requests

List Clients Roles listClientsRoles

GET

Try it out

Path Parameters

clientId *

Custom Query Parameters

Custom Headers

Return a list of roles that are assigned to a client

Path Parameters

clientId *: string

The unique identifier of the client application.

Related Operations:

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" } } ]

Too many requests

Create Clients Roles createClientsRoles

POST

Try it out

Path Parameters

clientId *

Custom Query Parameters

Custom Headers

Request Body application/json

Assign a list of roles to a client

Path Parameters

clientId *: string

The unique identifier of the client application.

Related Operations:

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

Too many requests

Delete Clients Roles deleteClientsRoles

DELETE

Try it out

Path Parameters

clientId *

Custom Query Parameters

Custom Headers

Request Body application/json

Unassign a list of roles from a client

Path Parameters

clientId *: string

The unique identifier of the client application.

Related Operations:

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

Too many requests

Get Clients Roles getClientsRoles

GET

Try it out

Path Parameters

clientId *

roleId *

Custom Query Parameters

Custom Headers

Return a role is assigned to a client

Path Parameters

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listClientsRoles.$.id

roleId *: string

The unique identifier of the role.

Related Operations:

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" } } ]

Too many requests

Create Client Role createClientRole

POST

Try it out

Path Parameters

clientId *

roleId *

Custom Query Parameters

Custom Headers

Request Body application/json

Assign a role to a client

Path Parameters

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listClientsRoles.$.id

roleId *: string

The unique identifier of the role.

Related Operations:

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

Too many requests

Delete Client Role deleteClientRole

DELETE

Try it out

Path Parameters

clientId *

roleId *

Custom Query Parameters

Custom Headers

Unassign a role from a client

Path Parameters

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listClientsRoles.$.id

roleId *: string

The unique identifier of the role.

Related Operations:

Response

Too many requests

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

includeUsage *

organizationId

hide_managed

offset

limit

search

sort

ascending *

Custom Query Parameters

Custom Headers

Get all connected applications for the organization

Query Parameters

includeUsage *: boolean

flag to indicate whether to return usage statistics

default: False

organizationId: string

Provide an orgId to get all clients from other organization

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

hide_managed: boolean

Hides the managed connected apps when set to true.

default: True

offset: integer

The number of records to omit from the response.

default: 0, min: 0

limit: integer

Maximum records to retrieve per request.

default: 20, min: 0, max: 20

search: string

A search string to use for case-insensitive partial matches on all object properties

sort: string

The field to sort on.

default: client_name

ascending *: boolean

Whether to sort ascending or descending

default: True

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

minLength: 1, maxLength: 255

enabled: boolean

owner_user_id: string

Send owner_user_id: null to create an Ownerless Connected App. Otherwise, it will default to the caller's ID.

minLength: 1, maxLength: 255

generate_iss_claim_without_token: boolean

public_keys: array

client_secret: string

minLength: 1, maxLength: 255

client_id: string

minLength: 1, maxLength: 255

tos_uri: string

minLength: 1, maxLength: 255

scopes: array

The level of permissions to provide to the app

client_uri: string

minLength: 1, maxLength: 255

redirect_uris *: array

Configure which URIs users should be directed to after authorization

owner_org_id: string

If provided, the App will be created in the target organization. Otherwise, it will default to the caller's organization.
Should only be provided if creating an Ownerless Connected App.

minLength: 1, maxLength: 255

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

minLength: 1, maxLength: 255

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

clientId *

Query Parameters

includeUsage *

Custom Query Parameters

Custom Headers

Get a single connected application

Path Parameters

clientId *: string

The unique identifier of the client application.

Related Operations:

Query Parameters

includeUsage *: boolean

flag to indicate whether to return usage statistics

default: False

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 }

Connected application with that clientId could not be found

Too many requests

Update Connected Applications updateConnectedApplications

PATCH

Try it out

Path Parameters

clientId *

Query Parameters

resetSecret

Custom Query Parameters

Custom Headers

Request Body application/json

Patches a single connected application

Path Parameters

clientId *: string

The unique identifier of the client application.

Related Operations:

Query Parameters

resetSecret: boolean

Asks service to reset secret as part of this operation

default: False

Request Body

json

client_id: string

minLength: 1, maxLength: 255

client_name: string

minLength: 1, maxLength: 255

client_secret: string

minLength: 1, maxLength: 255

owner_org_id: string

minLength: 1, maxLength: 255

owner_user_id: string

The ID of the user that owns the application. Sending a different ID transfers the application to a new owner.
Only Organization Administrators may own an application.
Ownerless Connected Apps cannot be given owners.
Owned Connected Apps cannot be made ownerless.

minLength: 1, maxLength: 255

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

minLength: 1, maxLength: 255

policy_uri: string

minLength: 1, maxLength: 255

tos_uri: string

minLength: 1, maxLength: 255

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 }

Connected application with that clientId could not be found

Too many requests

Delete Connected Applications deleteConnectedApplications

DELETE

Try it out

Path Parameters

clientId *

Custom Query Parameters

Custom Headers

Deletes a single connected application

Path Parameters

clientId *: string

The unique identifier of the client application.

Related Operations:

Response

Connected application was deleted

List Connected Applications Scopes listConnectedApplicationsScopes

GET

Try it out

Path Parameters

clientId *

Query Parameters

offset

limit

Custom Query Parameters

Custom Headers

Retrieves context-aware scopes assigned to the connected application

Path Parameters

clientId *: string

The unique identifier of the client application.

Related Operations:

Query Parameters

offset: integer

The number of records to omit from the response.

default: 0, min: 0

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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

clientId *

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

The unique identifier of the client application.

Related Operations:

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

clientId *

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

The unique identifier of the client application.

Related Operations:

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

clientId *

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

The unique identifier of the client application.

Related Operations:

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

clientId *

Custom Query Parameters

Custom Headers

Revoke all access tokens and refresh tokens issued to the connected application

Path Parameters

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.$.subOrganizationIds

Response

All tokens were revoked successfully

List Deleted Resources listDeletedResources

GET

Try it out

Query Parameters

deletedBefore *

deletedAfter *

parentOrgId *

organizationId *

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

search for the organization deleted

Related Operations:

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

deletedBefore *

deletedAfter *

organizationId *

envId *

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

search for all environments deleted that are associated with the specified orgnization

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.$.subOrganizationIds

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

environmentId *

Custom Query Parameters

Custom Headers

Retrieves an environment by id

Path Parameters

environmentId *: string

The id of an environment

Related Operations:

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" }

No environment exists with that id

Too many requests

Update Environments updateEnvironments

PUT

Try it out

Path Parameters

environmentId *

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

The id of an environment

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.$.subOrganizationIds

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" }

No environment exists with that id

Too many requests

Create Feature Flags Check createFeatureFlagsCheck

POST

Try it out

Path Parameters

featureFlagName *

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

featureFlagName *

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

organizationId *

offset

limit

search

sort

ascending *

Custom Query Parameters

Custom Headers

get outstanding or expired invites that match the criteria

Query Parameters

organizationId *: string

the id of the organization that the invites are for joining.

Related Operations:

offset: integer

The number of records to omit from the response.

default: 0, min: 0

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

search: string

A search string to use for case-insensitive partial matches on invited emails

sort: string

The field to sort on.

default: invited_email

ascending *: boolean

Whether to sort ascending or descending

default: True

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 }

Bad request; unknown organization, bad parameter or other failure

Too many requests

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

Bad request; unknown organization, bad parameter or other failure

Too many requests

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

Bad request; unknown organization, bad parameter or no invite was deleted

Too many requests

Get Invites getInvites

GET

Try it out

Path Parameters

inviteId *

Custom Query Parameters

Custom Headers

get an invite

Path Parameters

inviteId *: integer

The ID of the invite

Response

Success

Bad request; bad parameter or other failure

No invite exists in this organization for the given inviteId

Too many requests

List Invites Accept listInvitesAccept

GET

Try it out

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" }

Success; redirect the user to the application they were trying to visit

Invalid username or password

The user is disabled and cannot login

The user belongs to the other platform

target *: string

The target of the operation.

Examples

application/json

{ "target": "composer" }

Too many requests

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

Success; logout was not called via ajax so redirect to the login page

Too many requests

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.

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.

organizationPreferences *: object

Per-organization user preferences.

organizationId *: string

The unique identifier of the organization.

organization *: object

The organization that owns the resource.

memberOfOrganizations *: array

The organizations the user is a member of.

contributorOfOrganizations *: array

The organizations the user has contributor access to.

properties *: object

Additional properties 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": {} } }

An unknown error occurred

Too many requests

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

Bad request; invalid notification format

Too many requests

List Oauth2Authorize listOauth2Authorize

GET

Try it out

Query Parameters

redirect_uri *

response_type *

client_id *

state *

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

Bad request; an invalid redirect_uri, response_type or client_id

Too many requests

List Oauth2Authorize By Domain listOauth2AuthorizeByDomain

GET

Try it out

Path Parameters

domain *

Query Parameters

redirect_uri *

response_type *

client_id *

state *

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

Bad request; an invalid redirect_uri, response_type or client_id

Too many requests

Get Oauth2Authorize Providers getOauth2AuthorizeProviders

GET

Try it out

Path Parameters

domain *

providerId *

Query Parameters

redirect_uri *

response_type *

client_id *

state *

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

domain *

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

organizationName *

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

The organization name is available

Too many requests

Get Organizations getOrganizations

GET

Try it out

Path Parameters

organizationId *

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

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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.

hybrid *: object

Whether hybrid deployments are available to the organization.

hybridInsight *: boolean

Whether Hybrid Insight is available to the organization.

hybridAutoDiscoverProperties *: boolean

Whether hybrid runtimes can auto-discover platform properties.

createEnvironments *: boolean

Whether the organization is allowed to create environments.

globalDeployment *: boolean

Whether the entitlement allows global deployment of MuleSoft applications.

createSubOrgs *: boolean

Whether the organization is allowed to create sub-organizations.

vCoresProduction *: object

Number of production vCores included in the entitlement.

vCoresSandbox *: object

Number of sandbox vCores included in the entitlement.

vCoresDesign *: object

Number of design-time vCores included in the entitlement.

staticIps *: object

Number of static IPs available to the organization.

vpcs *: object

Number of Anypoint VPCs available to the organization.

vpns *: object

Number of VPN connections available to the organization.

networkConnections *: object

Number of network connections available to the organization.

workerLoggingOverride *: object

Whether the organization can override worker logging configuration.

messaging *: object

Whether Anypoint MQ is available to the organization.

mqMessages *: object

Number of Anypoint MQ messages included in the entitlement.

mqRequests *: object

Number of Anypoint MQ requests included in the entitlement.

mqAdvancedFeatures *: object

Whether Anypoint MQ advanced features are available to the organization.

objectStoreRequestUnits *: object

Number of Object Store request units included in the entitlement.

objectStoreKeys *: object

Number of Object Store keys included in the entitlement.

gateways *: object

Number of API gateways available to the organization.

designCenter *: object

Whether Anypoint Design Center is available to the organization.

partnersProduction *: object

Whether production capacity for partner-managed APIs is available to the organization.

partnersSandbox *: object

Whether sandbox capacity for partner-managed APIs is available to the organization.

tradingPartnersProduction *: object

Whether B2B Trading Partner Manager production capacity is available to the organization.

tradingPartnersSandbox *: object

Whether B2B Trading Partner Manager sandbox capacity is available to the organization.

loadBalancer *: object

Number of dedicated load balancers available to the organization.

externalIdentity *: boolean

Whether the user belongs to an external identity provider.

autoscaling *: boolean

Whether deployment autoscaling is available to the organization.

armAlerts *: boolean

Whether Anypoint Runtime Manager alerts are available to the organization.

apis *: object

Per-API limits or counters defined for the entitlement.

apiCatalog *: object

Whether the API catalog is available to the organization.

apiMonitoring *: object

Whether API monitoring is available to the organization.

apiCommunityManager *: object

Whether Anypoint API Community Manager is available to the organization.

apiExperienceHub *: object

Whether Anypoint API Experience Hub is available to the organization.

monitoringCenter *: object

Whether Anypoint Monitoring Center is available to the organization.

apiQuery *: object

Whether API Query is available to the organization.

apiQueryC360 *: object

Whether API Query for Customer 360 is available to the organization.

rpa *: object

Whether MuleSoft RPA is available to the organization.

idp *: object

Whether the organization can configure its own identity provider.

AutomationCreditsDW *: object

Number of automation credits available to the organization in Data Warehouse units.

apiGovernance *: object

Whether Anypoint API Governance is available to the organization.

apiGovernanceDomain *: object

Whether the API Governance domain feature is available to the organization.

crowd *: object

Whether the Crowd developer experience is available to the organization.

cam *: object

Whether Anypoint Connectivity Access Management (CAM) is available to the organization.

exchange2 *: object

Whether Anypoint Exchange 2 features are available to the organization.

crowdSelfServiceMigration *: object

Whether self-service migration to Crowd is available to the organization.

kpiDashboard *: object

Whether the KPI dashboard is available to the organization.

pcf *: boolean

Whether the Pivotal Cloud Foundry integration is available to the organization.

appViz *: boolean

Whether Anypoint Application Visualization is available to the organization.

workerClouds *: object

Whether MuleSoft worker clouds are available to the organization.

runtimeFabric *: boolean

Whether Anypoint Runtime Fabric is available to the organization.

serviceMesh *: object

Whether Anypoint Service Mesh is available to the organization.

flexGateway *: object

Whether Anypoint Flex Gateway is available to the organization.

managedGatewaySmall *: object

Number of small managed gateways available to the organization.

managedGatewayLarge *: object

Number of large managed gateways available to the organization.

rtfManagedGateway *: object

Number of Runtime Fabric managed gateways available to the organization.

runtimeFabricCloud *: object

Whether Anypoint Runtime Fabric (Cloud) is available to the organization.

composer *: object

Whether MuleSoft Composer is available to the organization.

muleDxWebIde *: object

Whether the Mule DX web IDE is available to the organization.

muleDxGenAI *: object

Whether Mule DX generative AI features are available to the organization.

muleDxEDA *: object

Whether Mule DX event-driven architecture features are available to the organization.

usageBasedPricing *: object

Whether usage-based pricing applies to the organization.

usageBasedPricingLimits *: object

Limits that apply to the organization under usage-based pricing.

highAvailability *: object

Whether the entitlement allows high-availability deployments.

cloudhub1 *: object

Whether CloudHub 1.0 is available to the organization.

telemetryExporter *: object

Whether the telemetry exporter is available to the organization.

anypointSecurityEdgePolicies *: object

Whether Anypoint Security edge policies are available to the organization.

anypointSecurityTokenization *: object

Whether Anypoint Security tokenization is available to the organization.

apiManager *: object

Whether Anypoint API Manager is available to the organization.

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.

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.

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

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates the referenced organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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.

hybridInsight *: boolean

Whether Hybrid Insight is available to the organization.

hybridAutoDiscoverProperties *: boolean

Whether hybrid runtimes can auto-discover platform properties.

createEnvironments *: boolean

Whether the organization is allowed to create environments.

globalDeployment *: boolean

Whether the entitlement allows global deployment of MuleSoft applications.

createSubOrgs *: boolean

Whether the organization is allowed to create sub-organizations.

vCoresProduction *: object

Number of production vCores included in the entitlement.

vCoresSandbox *: object

Number of sandbox vCores included in the entitlement.

staticIps *: object

Number of static IPs available to the organization.

vpcs *: object

Number of Anypoint VPCs available to the organization.

vpns *: object

Number of VPN connections available to the organization.

networkConnections *: object

Number of network connections available to the organization.

workerLoggingOverride *: object

Whether the organization can override worker logging configuration.

partnersProduction *: object

Whether production capacity for partner-managed APIs is available to the organization.

partnersSandbox *: object

Whether sandbox capacity for partner-managed APIs is available to the organization.

tradingPartnersProduction *: object

Whether B2B Trading Partner Manager production capacity is available to the organization.

tradingPartnersSandbox *: object

Whether B2B Trading Partner Manager sandbox capacity is available to the organization.

designCenter *: object

Whether Anypoint Design Center is available to the organization.

apiMonitoring *: object

Whether API monitoring is available to the organization.

apiCatalog *: object

Whether the API catalog is available to the organization.

apiCommunityManager *: object

Whether Anypoint API Community Manager is available to the organization.

apiExperienceHub *: object

Whether Anypoint API Experience Hub is available to the organization.

monitoringCenter *: object

Whether Anypoint Monitoring Center is available to the organization.

apiQuery *: object

Whether API Query is available to the organization.

apiQueryC360 *: object

Whether API Query for Customer 360 is available to the organization.

rpa *: object

Whether MuleSoft RPA is available to the organization.

idp *: object

Whether the organization can configure its own identity provider.

AutomationCreditsDW *: object

Number of automation credits available to the organization in Data Warehouse units.

apiGovernance *: object

Whether Anypoint API Governance is available to the organization.

apiGovernanceDomain *: object

Whether the API Governance domain feature is available to the organization.

workerClouds *: object

Whether MuleSoft worker clouds are available to the organization.

runtimeFabric *: boolean

Whether Anypoint Runtime Fabric is available to the organization.

serviceMesh *: object

Whether Anypoint Service Mesh is available to the organization.

flexGateway *: object

Whether Anypoint Flex Gateway is available to the organization.

managedGatewaySmall *: object

Number of small managed gateways available to the organization.

managedGatewayLarge *: object

Number of large managed gateways available to the organization.

rtfManagedGateway *: object

Number of Runtime Fabric managed gateways available to the organization.

runtimeFabricCloud *: object

Whether Anypoint Runtime Fabric (Cloud) is available to the organization.

composer *: object

Whether MuleSoft Composer is available to the organization.

muleDxWebIde *: object

Whether the Mule DX web IDE is available to the organization.

muleDxGenAI *: object

Whether Mule DX generative AI features are available to the organization.

muleDxEDA *: object

Whether Mule DX event-driven architecture features are available to the organization.

usageBasedPricing *: object

Whether usage-based pricing applies to the organization.

usageBasedPricingLimits *: object

Limits that apply to the organization under usage-based pricing.

highAvailability *: object

Whether the entitlement allows high-availability deployments.

cloudhub1 *: object

Whether CloudHub 1.0 is available to the organization.

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.

hybrid *: object

Whether hybrid deployments are available to the organization.

hybridInsight *: boolean

Whether Hybrid Insight is available to the organization.

hybridAutoDiscoverProperties *: boolean

Whether hybrid runtimes can auto-discover platform properties.

createEnvironments *: boolean

Whether the organization is allowed to create environments.

globalDeployment *: boolean

Whether the entitlement allows global deployment of MuleSoft applications.

createSubOrgs *: boolean

Whether the organization is allowed to create sub-organizations.

vCoresProduction *: object

Number of production vCores included in the entitlement.

vCoresSandbox *: object

Number of sandbox vCores included in the entitlement.

vCoresDesign *: object

Number of design-time vCores included in the entitlement.

staticIps *: object

Number of static IPs available to the organization.

vpcs *: object

Number of Anypoint VPCs available to the organization.

vpns *: object

Number of VPN connections available to the organization.

networkConnections *: object

Number of network connections available to the organization.

workerLoggingOverride *: object

Whether the organization can override worker logging configuration.

messaging *: object

Whether Anypoint MQ is available to the organization.

mqMessages *: object

Number of Anypoint MQ messages included in the entitlement.

mqRequests *: object

Number of Anypoint MQ requests included in the entitlement.

mqAdvancedFeatures *: object

Whether Anypoint MQ advanced features are available to the organization.

objectStoreRequestUnits *: object

Number of Object Store request units included in the entitlement.

objectStoreKeys *: object

Number of Object Store keys included in the entitlement.

gateways *: object

Number of API gateways available to the organization.

designCenter *: object

Whether Anypoint Design Center is available to the organization.

partnersProduction *: object

Whether production capacity for partner-managed APIs is available to the organization.

partnersSandbox *: object

Whether sandbox capacity for partner-managed APIs is available to the organization.

tradingPartnersProduction *: object

Whether B2B Trading Partner Manager production capacity is available to the organization.

tradingPartnersSandbox *: object

Whether B2B Trading Partner Manager sandbox capacity is available to the organization.

loadBalancer *: object

Number of dedicated load balancers available to the organization.

externalIdentity *: boolean

Whether the user belongs to an external identity provider.

autoscaling *: boolean

Whether deployment autoscaling is available to the organization.

armAlerts *: boolean

Whether Anypoint Runtime Manager alerts are available to the organization.

apis *: object

Per-API limits or counters defined for the entitlement.

apiCatalog *: object

Whether the API catalog is available to the organization.

apiMonitoring *: object

Whether API monitoring is available to the organization.

apiCommunityManager *: object

Whether Anypoint API Community Manager is available to the organization.

apiExperienceHub *: object

Whether Anypoint API Experience Hub is available to the organization.

monitoringCenter *: object

Whether Anypoint Monitoring Center is available to the organization.

apiQuery *: object

Whether API Query is available to the organization.

apiQueryC360 *: object

Whether API Query for Customer 360 is available to the organization.

rpa *: object

Whether MuleSoft RPA is available to the organization.

idp *: object

Whether the organization can configure its own identity provider.

AutomationCreditsDW *: object

Number of automation credits available to the organization in Data Warehouse units.

apiGovernance *: object

Whether Anypoint API Governance is available to the organization.

apiGovernanceDomain *: object

Whether the API Governance domain feature is available to the organization.

crowd *: object

Whether the Crowd developer experience is available to the organization.

cam *: object

Whether Anypoint Connectivity Access Management (CAM) is available to the organization.

exchange2 *: object

Whether Anypoint Exchange 2 features are available to the organization.

crowdSelfServiceMigration *: object

Whether self-service migration to Crowd is available to the organization.

kpiDashboard *: object

Whether the KPI dashboard is available to the organization.

pcf *: boolean

Whether the Pivotal Cloud Foundry integration is available to the organization.

appViz *: boolean

Whether Anypoint Application Visualization is available to the organization.

workerClouds *: object

Whether MuleSoft worker clouds are available to the organization.

runtimeFabric *: boolean

Whether Anypoint Runtime Fabric is available to the organization.

runtimeFabricCloud *: object

Whether Anypoint Runtime Fabric (Cloud) is available to the organization.

serviceMesh *: object

Whether Anypoint Service Mesh is available to the organization.

flexGateway *: object

Whether Anypoint Flex Gateway is available to the organization.

managedGatewaySmall *: object

Number of small managed gateways available to the organization.

managedGatewayLarge *: object

Number of large managed gateways available to the organization.

rtfManagedGateway *: object

Number of Runtime Fabric managed gateways available to the organization.

composer *: object

Whether MuleSoft Composer is available to the organization.

muleDxWebIde *: object

Whether the Mule DX web IDE is available to the organization.

muleDxGenAI *: object

Whether Mule DX generative AI features are available to the organization.

muleDxEDA *: object

Whether Mule DX event-driven architecture features are available to the organization.

cloudhub1 *: object

Whether CloudHub 1.0 is available to the organization.

telemetryExporter *: object

Whether the telemetry exporter is available to 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.

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" } }

Invalid or incomplete body

Too many requests

Delete Organizations deleteOrganizations

DELETE

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Deletes the referenced organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Success

Invalid or incomplete body

Too many requests

List Client Providers listClientProviders

GET

Try it out

Path Parameters

organizationId *

Query Parameters

provider_id

offset

ascending *

cp_type

sort

limit

search

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

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

provider_id: array

One or more ids of the provider(s) to return.

offset: integer

The number of records to omit from the response.

default: 0, min: 0

ascending *: boolean

Whether to sort ascending or descending

default: True

cp_type: array

One or more types of provider(s) to return.

sort: string

The field to sort on.

default: provider_id

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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

organizationId *

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

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

Response

Success

Invalid data in body

Unauthorized

Organization does not exist

The organization is not a root organization

Too many requests

Get Client Providers getClientProviders

GET

Try it out

Path Parameters

organizationId *

clientProviderId *

Query Parameters

includeSecrets *

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

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientProviderId *: string

The unique identifier of the client provider id.

Related Operations:

access-management#listClientProviders.$.data[*].providerId

Query Parameters

includeSecrets *: boolean

flag to include the secrets as part of the response or not

default: False

Response

Success

Unauthorized

Client Provider ID does not exist in the Organization

Too many requests

Update Client Providers updateClientProviders

PUT

Try it out

Path Parameters

organizationId *

clientProviderId *

Custom Query Parameters

Custom Headers

Request Body application/json

Replaces the associated client management provider config

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientProviderId *: string

The unique identifier of the client provider id.

Related Operations:

access-management#listClientProviders.$.data[*].providerId

Request Body

json

Response

Success

Invalid data in body

Unauthorized

Client Provider ID does not exist in the Organization

The organization is not a root organization

Too many requests

Update Organization Client Provider updateOrganizationClientProvider

PATCH

Try it out

Path Parameters

organizationId *

clientProviderId *

Query Parameters

recreateTokenValidationClient *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates the associated client management provider config

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientProviderId *: string

The unique identifier of the client provider id.

Related Operations:

access-management#listClientProviders.$.data[*].providerId

Query Parameters

recreateTokenValidationClient *: boolean

flag to indicate whether to recreate token validation client on update or not

default: False

Request Body

json

Response

Success

Invalid data in body

Unauthorized

Client Provider ID does not exist in the Organization

The organization is not a root organization

Too many requests

Delete Client Providers deleteClientProviders

DELETE

Try it out

Path Parameters

organizationId *

clientProviderId *

Custom Query Parameters

Custom Headers

Deletes the associated client management provider

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientProviderId *: string

The unique identifier of the client provider id.

Related Operations:

access-management#listClientProviders.$.data[*].providerId

Response

Success

Unauthorized

Client Provider ID does not exist in the Organization

The organization is not a root organization

Too many requests

List Client Providers Grant Types listClientProvidersGrantTypes

GET

Try it out

Path Parameters

organizationId *

clientProviderId *

Custom Query Parameters

Custom Headers

Returns the associated client management provider type and grant types it suppports.

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientProviderId *: string

The unique identifier of the client provider id.

Related Operations:

access-management#listClientProviders.$.data[*].providerId

Response

json

Success

type *: object

grant_types *: array

List Client Providers Clients listClientProvidersClients

GET

Try it out

Path Parameters

organizationId *

clientProviderId *

Query Parameters

client_id

offset

ascending *

sort

limit

search

Custom Query Parameters

Custom Headers

Returns the clients created using this specific Client Management Provider

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientProviderId *: string

The unique identifier of the client provider id.

Related Operations:

access-management#listClientProviders.$.data[*].providerId

Query Parameters

client_id: array

One or more ids of the client(s) to return.

offset: integer

The number of records to omit from the response.

default: 0, min: 0

ascending *: boolean

Whether to sort ascending or descending

default: True

sort: string

The field to sort on.

default: client_id

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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 }

Unauthorized

Organization or Client Management Provider does not exist

Too many requests

Create Client Providers Clients createClientProvidersClients

POST

Try it out

Path Parameters

organizationId *

clientProviderId *

Custom Query Parameters

Custom Headers

Request Body application/json

Adds a new client using the Client Management Provider

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientProviderId *: string

The unique identifier of the client provider id.

Related Operations:

access-management#listClientProviders.$.data[*].providerId

Request Body

json

client_name: string

minLength: 1, maxLength: 255

client_id: string

minLength: 1, maxLength: 255

client_secret: string

minLength: 10, maxLength: 255

grant_types: array

redirect_uris: array

Response

Success

Invalid data in body

Unauthorized

Organization or Client Management Provider does not exist

The organization is not a root organization

Too many requests

Get Client Providers Clients getClientProvidersClients

GET

Try it out

Path Parameters

organizationId *

clientProviderId *

clientId *

Custom Query Parameters

Custom Headers

Returns the associated clients info

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientProviderId *: string

The unique identifier of the client provider id.

Related Operations:

access-management#listClientProviders.$.data[*].providerId

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listClientProvidersClients.$.id

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" }

Unauthorized

ClientId does not exist in the Organization or Client Management Provider

Too many requests

Update Client Providers Clients updateClientProvidersClients

PATCH

Try it out

Path Parameters

organizationId *

clientProviderId *

clientId *

Query Parameters

force

resetSecret

Custom Query Parameters

Custom Headers

Request Body application/json

Updates the associated client

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientProviderId *: string

The unique identifier of the client provider id.

Related Operations:

access-management#listClientProviders.$.data[*].providerId

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listClientProvidersClients.$.id

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

Asks service to reset secret as part of this operation

default: False

Request Body

json

client_name: string

minLength: 1, maxLength: 255

client_id: string

minLength: 1, maxLength: 255

client_secret: string

minLength: 10, maxLength: 255

grant_types: array

redirect_uris: array

Response

Success

Invalid data in body

Unauthorized

ClientId does not exist in the Organization or Client Management Provider

The organization is not a root organization

Too many requests

Delete Client Providers Clients deleteClientProvidersClients

DELETE

Try it out

Path Parameters

organizationId *

clientProviderId *

clientId *

Query Parameters

force

Custom Query Parameters

Custom Headers

Deletes the associated client

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientProviderId *: string

The unique identifier of the client provider id.

Related Operations:

access-management#listClientProviders.$.data[*].providerId

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listClientProvidersClients.$.id

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

Unauthorized

ClientId does not exist in the Organization or Client Management Provider

The organization is not a root organization

Too many requests

List Organization Clients listOrganizationClients

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Get all clients

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Create a new client

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

clientId *

Custom Query Parameters

Custom Headers

Get a single client

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

clientId *

Query Parameters

resetSecret *

Custom Query Parameters

Custom Headers

Request Body application/json

Patches a single client

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

Custom Query Parameters

Custom Headers

Request Body application/json

Assign a list of roles to a client

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

Too many requests

Delete Organization Client Roles deleteOrganizationClientRoles

DELETE

Try it out

Path Parameters

organizationId *

clientId *

Custom Query Parameters

Custom Headers

Request Body application/json

Unassign a list of roles from a client

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

Too many requests

Create Organization Client Role By Id createOrganizationClientRoleById

POST

Try it out

Path Parameters

organizationId *

clientId *

roleId *

Custom Query Parameters

Custom Headers

Request Body application/json

Assign a role to a client

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

Too many requests

Delete Organization Client Role deleteOrganizationClientRole

DELETE

Try it out

Path Parameters

organizationId *

clientId *

roleId *

Custom Query Parameters

Custom Headers

Unassign a role from a client

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

roleId *: string

The unique identifier of the role.

Response

Too many requests

Create Organization Clients Search createOrganizationClientsSearch

POST

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Search clients

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

Request Body

json

name: string

minLength: 1, maxLength: 255

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

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Validate clients

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

client_id *: string

minLength: 1, maxLength: 255

client_secret: string

minLength: 1, maxLength: 255

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

organizationId *

Query Parameters

includeUsage *

hide_managed

organizationId

offset

ascending *

sort

limit

search

Custom Query Parameters

Custom Headers

Get all connected applications for the organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

includeUsage *: boolean

flag to indicate whether to return usage statistics

default: False

hide_managed: boolean

Hides the managed connected apps when set to true.

default: True

organizationId: string

Provide an orgId to get all clients from other organization

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

offset: integer

The number of records to omit from the response.

default: 0, min: 0

ascending *: boolean

Whether to sort ascending or descending

default: True

sort: string

The field to sort on.

default: client_name

limit: integer

Maximum records to retrieve per request.

default: 20, min: 0, max: 20

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

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Create a new connected application

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

grant_types: array

The grant types to be used with this app

client_name: string

minLength: 1, maxLength: 255

enabled: boolean

owner_user_id: string

Send owner_user_id: null to create an Ownerless Connected App. Otherwise, it will default to the caller's ID.

minLength: 1, maxLength: 255

generate_iss_claim_without_token: boolean

public_keys: array

client_secret: string

minLength: 1, maxLength: 255

client_id: string

minLength: 1, maxLength: 255

tos_uri: string

minLength: 1, maxLength: 255

scopes: array

The level of permissions to provide to the app

client_uri: string

minLength: 1, maxLength: 255

redirect_uris *: array

Configure which URIs users should be directed to after authorization

owner_org_id: string

If provided, the App will be created in the target organization. Otherwise, it will default to the caller's organization.
Should only be provided if creating an Ownerless Connected App.

minLength: 1, maxLength: 255

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

minLength: 1, maxLength: 255

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

organizationId *

clientId *

Query Parameters

includeUsage *

Custom Query Parameters

Custom Headers

Get a single connected application

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listOrganizationConnectedApplications.$.id

Query Parameters

includeUsage *: boolean

flag to indicate whether to return usage statistics

default: False

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 }

Connected application with that clientId could not be found

Too many requests

Update Organization Connected Application updateOrganizationConnectedApplication

PATCH

Try it out

Path Parameters

organizationId *

clientId *

Query Parameters

resetSecret

Custom Query Parameters

Custom Headers

Request Body application/json

Patches a single connected application

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listOrganizationConnectedApplications.$.id

Query Parameters

resetSecret: boolean

Asks service to reset secret as part of this operation

default: False

Request Body

json

client_id: string

minLength: 1, maxLength: 255

client_name: string

minLength: 1, maxLength: 255

client_secret: string

minLength: 1, maxLength: 255

owner_org_id: string

minLength: 1, maxLength: 255

owner_user_id: string

The ID of the user that owns the application. Sending a different ID transfers the application to a new owner.
Only Organization Administrators may own an application.
Ownerless Connected Apps cannot be given owners.
Owned Connected Apps cannot be made ownerless.

minLength: 1, maxLength: 255

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

minLength: 1, maxLength: 255

policy_uri: string

minLength: 1, maxLength: 255

tos_uri: string

minLength: 1, maxLength: 255

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 }

Connected Application with that organizationId and clientId could not be found

Too many requests

Delete Organization Connected Application deleteOrganizationConnectedApplication

DELETE

Try it out

Path Parameters

organizationId *

clientId *

Custom Query Parameters

Custom Headers

Deletes a single connected application

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listOrganizationConnectedApplications.$.id

Response

Connected application was deleted

List Organization Connected Application Scopes listOrganizationConnectedApplicationScopes

GET

Try it out

Path Parameters

organizationId *

clientId *

Query Parameters

offset

limit

Custom Query Parameters

Custom Headers

Retrieves context-aware scopes assigned to the connected application

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listOrganizationConnectedApplications.$.id

Query Parameters

offset: integer

The number of records to omit from the response.

default: 0, min: 0

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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

organizationId *

clientId *

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

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listOrganizationConnectedApplications.$.id

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

organizationId *

clientId *

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

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listOrganizationConnectedApplications.$.id

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

organizationId *

clientId *

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

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

clientId *: string

The unique identifier of the client application.

Related Operations:

access-management#listOrganizationConnectedApplications.$.id

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

user_id

offset

limit

Custom Query Parameters

Custom Headers

Returns all the authorizations that grant access to resources in the organization.

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

user_id: string

Only return authorizations granted by that user

offset: integer

The number of records to omit from the response.

default: 0, min: 0

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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

organizationId *

Query Parameters

user_id *

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

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

user_id *: string

Only delete authorizations granted by that user

Response

Success

The organization is a business group. Revoking must be done from a root organization

Too many requests

Get Connected Applications Authorizations getConnectedApplicationsAuthorizations

GET

Try it out

Path Parameters

organizationId *

authorizationId *

Custom Query Parameters

Custom Headers

Returns a single authorization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

The ID of the user who granted the authorization

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

client_id *: string

The ID of the client who is granted the authorization

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

scopes *: array

The list of OAuth2 scopes contained in the authorization

Delete Organization Connected Application Authorization deleteOrganizationConnectedApplicationAuthorization

DELETE

Try it out

Path Parameters

organizationId *

authorizationId *

Custom Query Parameters

Custom Headers

Revokes an authorization. Only available on the root organization.

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

authorizationId *: string

The ID of the authorization

Response

Success

The organization is a business group. Revoking must be done from a root organization

Too many requests

List Connected Applications Settings listConnectedApplicationsSettings

GET

Try it out

Path Parameters

organizationId *

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

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

json

Success

whitelist_enabled: boolean

Deprecated. Use allowlist_enabled instead. When both properties are being set, allowlist_enabled is observed.
If true, only applications on the Organization's allowlist may ask for consent/receive tokens.
If false, any application can ask for consent/receive tokens.

allowlist_enabled: boolean

If true, only applications on the Organization's allowlist may ask for consent/receive tokens.
If false, any application can ask for consent/receive tokens.

applications_enabled *: string

If all, clients may access resouces in the Organization via any grant type.
If none, clients may not access the Organization - this disables Connected Applications.
If partial, clients may access resources in the Organization ony using grant_types in the grant_types_allowed list

grant_types_allowed *: array

The list of all grant types the Organization allows clients to use

whitelist_internal_applications: boolean

Deprecated. Use allowlist_internal_applications instead. When both properties are being set,
allowlist_internal_applications is observed.
If true, all internal applications are auto-approved to be part of the allowlist.
If false, internal applications must be added to the allowlist like any other app.

allowlist_internal_applications: boolean

If true, all internal applications are auto-approved to be part of the allowlist.
If false, internal applications must be added to the allowlist like any other app.

The organization does not exist

Too many requests

Update Connected Applications Settings updateConnectedApplicationsSettings

PATCH

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates the organization's connected application settings

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

grant_types_allowed *: array

The list of all grant types the Organization allows clients to use

whitelist_enabled: boolean

Deprecated. Use allowlist_enabled instead. When both properties are being set, allowlist_enabled is observed.
If true, only applications on the Organization's allowlist may ask for consent/receive tokens.
If false, any application can ask for consent/receive tokens.

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

Deprecated. Use allowlist_internal_applications instead. When both properties are being set,
allowlist_internal_applications is observed.
If true, all internal applications are auto-approved to be part of the allowlist.
If false, internal applications must be added to the allowlist like any other app.

allowlist_internal_applications: boolean

If true, all internal applications are auto-approved to be part of the allowlist.
If false, internal applications must be added to the allowlist like any other app.

allowlist_enabled: boolean

If true, only applications on the Organization's allowlist may ask for consent/receive tokens.
If false, any application can ask for consent/receive tokens.

applications_enabled *: string

If all, clients may access resouces in the Organization via any grant type.
If none, clients may not access the Organization - this disables Connected Applications.
If partial, clients may access resources in the Organization ony using grant_types in the grant_types_allowed list

Response

json

Success

whitelist_enabled: boolean

Deprecated. Use allowlist_enabled instead. When both properties are being set, allowlist_enabled is observed.
If true, only applications on the Organization's allowlist may ask for consent/receive tokens.
If false, any application can ask for consent/receive tokens.

allowlist_enabled: boolean

If true, only applications on the Organization's allowlist may ask for consent/receive tokens.
If false, any application can ask for consent/receive tokens.

applications_enabled *: string

If all, clients may access resouces in the Organization via any grant type.
If none, clients may not access the Organization - this disables Connected Applications.
If partial, clients may access resources in the Organization ony using grant_types in the grant_types_allowed list

grant_types_allowed *: array

The list of all grant types the Organization allows clients to use

whitelist_internal_applications: boolean

Deprecated. Use allowlist_internal_applications instead. When both properties are being set,
allowlist_internal_applications is observed.
If true, all internal applications are auto-approved to be part of the allowlist.
If false, internal applications must be added to the allowlist like any other app.

allowlist_internal_applications: boolean

If true, all internal applications are auto-approved to be part of the allowlist.
If false, internal applications must be added to the allowlist like any other app.

The organization does not exist

The organization is a business group. Settings are only editable on a root organization

Too many requests

List Connected Applications Allowlist listConnectedApplicationsAllowlist

GET

Try it out

Path Parameters

organizationId *

Query Parameters

client_id

offset

limit

Custom Query Parameters

Custom Headers

Returns the entries on the organization's Connected Application allowlist

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

client_id: array

search for allowlist entries by specific client_id

offset: integer

The number of records to omit from the response.

default: 0, min: 0

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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 }

The organization does not exist

Too many requests

Update Connected Applications Allowlist updateConnectedApplicationsAllowlist

PUT

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

items: array

Array items

Response

Success

The organization does not exist

The organization is a business group. The allowlist is only editable on a root organization.

Too many requests

Delete Connected Applications Allowlist deleteConnectedApplicationsAllowlist

DELETE

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Deletes the entries from the organization's Connected Application allowlist

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

items: array

Array items

Response

Success

The organization does not exist

The organization is a business group. The allowlist is only editable on a root organization

Too many requests

List Connected Applications Whitelist listConnectedApplicationsWhitelist

GET

Try it out

Path Parameters

organizationId *

Query Parameters

client_id

offset

limit

Custom Query Parameters

Custom Headers

Returns the entries on the organization's Connected Application allowlist

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

client_id: array

search for allowlist entries by specific client_id

offset: integer

The number of records to omit from the response.

default: 0, min: 0

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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 }

The organization does not exist

Too many requests

Update Connected Applications Whitelist updateConnectedApplicationsWhitelist

PUT

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

items: array

Array items

Response

Success

The organization does not exist

The organization is a business group. The allowlist is only editable on a root organization.

Too many requests

Delete Connected Applications Whitelist deleteConnectedApplicationsWhitelist

DELETE

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Deletes the entries from the organization's Connected Application allowlist

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

items: array

Array items

Response

Success

The organization does not exist

The organization is a business group. The allowlist is only editable on a root organization

Too many requests

List Entitlements listEntitlements

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Returns the entitlements for the organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Success

Get Entitlements getEntitlements

GET

Try it out

Path Parameters

organizationId *

entitlementName *

Custom Query Parameters

Custom Headers

Get an entitlement by name

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

entitlementName *: string

The name of an entitlement

Response

Success

Entitlement with that name does not exists

Too many requests

Update Entitlements updateEntitlements

PUT

Try it out

Path Parameters

organizationId *

entitlementName *

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

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

Entitlement with that name does not exists

Too many requests

List Environments listEnvironments

GET

Try it out

Path Parameters

organizationId *

Query Parameters

name

isProduction

expandAll

offset

type

limit

search

Custom Query Parameters

Custom Headers

Returns all matching environments

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

The number of records to omit from the response.

default: 0, min: 0

type: string

The type of environment - production, sandbox, or/or design

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Creates an environment

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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" }

Failed to create the environment because of invalid input. Often times it is the name containing invalid characters (names must be alpha-numeric and between 2 & 65 characters long).

The organization is not entitled to be able to create new environments.

Too many requests

Get Organization Environment getOrganizationEnvironment

GET

Try it out

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

Custom Headers

Retrieves an environment by id

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The id of an environment

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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" }

No environment exists with that id

Too many requests

Update Organization Environment updateOrganizationEnvironment

PUT

Try it out

Path Parameters

organizationId *

environmentId *

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

The ID of the organization in GUID format

Related Operations:

environmentId *: string

The id of an environment

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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" }

No environment exists with that id

Too many requests

Delete Environments deleteEnvironments

DELETE

Try it out

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

Custom Headers

Delete an environment

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

environmentId *: string

The id of an environment

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Successful. Returns zero length body

No environment exists with that id

Too many requests

List Environments Client Management Providers listEnvironmentsClientManagementProviders

GET

Try it out

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

Custom Headers

Retrieves client management providers for the environment

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

environmentId *: string

The id of an environment

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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" ] }

No environment exists with that id

Too many requests

Update Environments Client Management Providers updateEnvironmentsClientManagementProviders

PUT

Try it out

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

Custom Headers

organizationId *: string

The ID of the organization in GUID format

Related Operations:

Query Parameters

offset: integer

The number of records to omit from the response.

default: 0, min: 0

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

Response

Custom Query Parameters

Custom Headers

Request Body application/json

API to upsert a feature flag.

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

featureFlagName *: string

The name of the feature flag to evaluate.

Request Body

json

context: object

enabled *: boolean

Response

Success

Bad Request

Too many requests

List Hierarchy listHierarchy

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

get Business Groups (down to the leaves) of this organization.

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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.

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(email)

The user's email address.

organizationId *: string

The unique identifier of the organization.

enabled *: boolean

Whether the feature or resource is currently enabled.

idprovider_id *: string

The unique identifier of the identity provider.

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" } } ] }

Bad request; unknown organization.

Too many requests

List Identity Providers listIdentityProviders

GET

Try it out

Path Parameters

organizationId *

Query Parameters

include_full_details *

provider_id

offset

idp_type

ascending *

sort

limit

search

Custom Query Parameters

Custom Headers

Returns list of identity management providers for the root organization with a subset of values.

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

include_full_details *: boolean

If true, returns the full set of properties

default: False

provider_id: array

One or more ids of the provider(s) to return.

offset: integer

The number of records to omit from the response.

default: 0, min: 0

idp_type: array

One or more types of provider(s) to return.

ascending *: boolean

Whether to sort ascending or descending

default: True

sort: string

The field to sort on.

default: provider_id

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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 }

The organization is not a root organization

Too many requests

Create Identity Providers createIdentityProviders

POST

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Add a new identity management provider to the root organization.

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

Response

Success

Invalid data in body

Cannot add identity providers to business groups

Too many requests

List Identity Providers Saml Sp Metadata listIdentityProvidersSamlSpMetadata

GET

Try it out

Path Parameters

organizationId *

Query Parameters

provider_id *

Custom Query Parameters

Custom Headers

Download the SAML SP metadata of the associated SAML identity management provider

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

provider_id *: string

ID of the provider to get the associated SAML SP metadata.

Response

Success

The organization is not a root organization

Too many requests

Create Identity Providers Ldap Test createIdentityProvidersLdapTest

POST

Try it out

Path Parameters

organizationId *

Query Parameters

provider_id

Custom Query Parameters

Custom Headers

Request Body application/json

Test the LDAP config before saving the configuration

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

Invalid data in body

The organization is not a root organization

Too many requests

Get Identity Providers getIdentityProviders

GET

Try it out

Path Parameters

organizationId *

identityProviderId *

Query Parameters

include_secrets *

Custom Query Parameters

Custom Headers

Returns the associated identity management provider config.

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

identityProviderId *: string

The unique identifier of the identity provider id.

Related Operations:

access-management#listIdentityProviders.$.data[*].provider_id

Query Parameters

include_secrets *: boolean

If true, include secrets in the response

default: False

Response

Success

The organization is not a root organization

Too many requests

Update Identity Providers updateIdentityProviders

PATCH

Try it out

Path Parameters

organizationId *

identityProviderId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates the associated identity management provider config

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

identityProviderId *: string

The unique identifier of the identity provider id.

Related Operations:

access-management#listIdentityProviders.$.data[*].provider_id

Request Body

json

Response

Success

Invalid data in body

The organization is not a root organization

Too many requests

Delete Identity Providers deleteIdentityProviders

DELETE

Try it out

Path Parameters

organizationId *

identityProviderId *

Custom Query Parameters

Custom Headers

Deletes the associated identity management provider

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

identityProviderId *: string

The unique identifier of the identity provider id.

Related Operations:

access-management#listIdentityProviders.$.data[*].provider_id

Response

Success

The organization is not a root organization

Too many requests

List Identity Providers Saml Sp Keys listIdentityProvidersSamlSpKeys

GET

Try it out

Path Parameters

organizationId *

identityProviderId *

Query Parameters

primary

Custom Query Parameters

Custom Headers

Returns the list of SAML SP keys associated to the identity management provider config

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

identityProviderId *: string

The unique identifier of the identity provider id.

Related Operations:

access-management#listIdentityProviders.$.data[*].provider_id

Query Parameters

primary: boolean

If true, return only the primary SAML SP key

default: False

Response

json

Success

items: array

Array items

The identity provider does not exist or is not a SAML provider

The organization is not a root organization

Too many requests

Create Identity Providers Saml Sp Keys createIdentityProvidersSamlSpKeys

POST

Try it out

Path Parameters

organizationId *

identityProviderId *

Custom Query Parameters

Custom Headers

Request Body application/json

Add or generate a new SAML SP key pair

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

identityProviderId *: string

The unique identifier of the identity provider id.

Related Operations:

access-management#listIdentityProviders.$.data[*].provider_id

Request Body

json

key_pair: object

Response

json

Success

id *: string

primary *: boolean

created_at *: string

is_default_certificate: boolean

The identity provider does not exist or is not a SAML provider

The organization is not a root organization

Too many requests

Get Identity Providers Saml Sp Keys getIdentityProvidersSamlSpKeys

GET

Try it out

Path Parameters

organizationId *

identityProviderId *

samlSpKeyId *

Custom Query Parameters

Custom Headers

Returns the SAML SP certificate in .pem format

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

identityProviderId *: string

The unique identifier of the identity provider id.

Related Operations:

access-management#listIdentityProviders.$.data[*].provider_id

samlSpKeyId *: string

The unique identifier of the saml sp key id.

Response

Success

The key or identity provider does not exist, or it is not a SAML provider

The organization is not a root organization

Too many requests

Delete Identity Providers Saml Sp Keys deleteIdentityProvidersSamlSpKeys

DELETE

Try it out

Path Parameters

organizationId *

identityProviderId *

samlSpKeyId *

Custom Query Parameters

Custom Headers

Delete the SAML SP key

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

identityProviderId *: string

The unique identifier of the identity provider id.

Related Operations:

access-management#listIdentityProviders.$.data[*].provider_id

samlSpKeyId *: string

The unique identifier of the saml sp key id.

Response

Success

The key or identity provider does not exist, or it is not a SAML provider

The organization is not a root organization

Too many requests

Create Identity Providers Saml Sp Keys Set Primary createIdentityProvidersSamlSpKeysSetPrimary

POST

Try it out

Path Parameters

organizationId *

identityProviderId *

samlSpKeyId *

Custom Query Parameters

Custom Headers

Make the key the primary SAML SP key for the identity management provider config

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

identityProviderId *: string

The unique identifier of the identity provider id.

Related Operations:

access-management#listIdentityProviders.$.data[*].provider_id

samlSpKeyId *: string

The unique identifier of the saml sp key id.

Response

json

Success

items: array

Array items

The key or identity provider does not exist, or it is not a SAML provider

The organization is not a root organization

Too many requests

List Identity Provider Settings listIdentityProviderSettings

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Get the identity provider settings for the org

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

json

Success

allow_new_non_sso_users: boolean

bypass_expiration: boolean

Update Identity Provider Settings updateIdentityProviderSettings

PATCH

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Update the identity provider settings for the org

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

allow_new_non_sso_users: boolean

bypass_expiration: boolean

Response

Success

Invalid data in body

The organization is not a root organization

List Organization Invites listOrganizationInvites

GET

Try it out

Path Parameters

organizationId *

Query Parameters

offset

limit

search

Custom Query Parameters

Custom Headers

get outstanding or expired invites that match the criteria

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

offset: integer

The number of records to omit from the response.

default: 0, min: 0

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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 }

Bad request; unknown organization, bad parameter or other failure

Too many requests

Create Organization Invite createOrganizationInvite

POST

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Invite a person to join the organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

Response

json

Success

items: array

Array items

Bad request; unknown organization, bad parameter or other failure

Too many requests

Delete Organization Invites deleteOrganizationInvites

DELETE

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Invite a person to join your organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

items: array

Array items

Response

Success

Bad request; unknown organization, bad parameter or no invite was deleted

Too many requests

Get Organization Invite getOrganizationInvite

GET

Try it out

Path Parameters

organizationId *

inviteId *

Custom Query Parameters

Custom Headers

get an invite

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

inviteId *: integer

The ID of the invite

Response

Success

Bad request; bad parameter or other failure

No invite exists in this organization for the given inviteId

Too many requests

Resend Organization Invite resendOrganizationInvite

POST

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Resend a list of invites

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

items: array

Array items

Response

json

Success

succeeded *: array

failed *: array

One or more of the invites are not in the organization or no invites were sent

Too many requests

List Members listMembers

GET

Try it out

Path Parameters

organizationId *

Query Parameters

username *

lastName *

firstName *

offset

limit

search *

Custom Query Parameters

Custom Headers

Get members from an organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

The number of records to omit from the response.

default: 0, min: 0

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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 }

The organization does not exist

Too many requests

Update Members updateMembers

PUT

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Add a group of users to the organization by their IDs

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

Invalid IDs or some users could not be added to the org

The organization does not exist

Too many requests

Delete Members deleteMembers

DELETE

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Remove a group of users from the organization by their IDs

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

Invalid IDs or some users could not be removed from the org

The organization does not exist

Too many requests

Update Organization Member updateOrganizationMember

PUT

Try it out

Path Parameters

organizationId *

userId *

Custom Query Parameters

Custom Headers

Request Body application/json

Add the user to the organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

userId *: string

The ID of the user in GUID format

Related Operations:

access-management#listMembers.$.id

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

Invalid ID or this user could not be added to the org

The organization does not exist

Too many requests

Delete Organization Member deleteOrganizationMember

DELETE

Try it out

Path Parameters

organizationId *

userId *

Custom Query Parameters

Custom Headers

Request Body application/json

Remove the user from the organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

userId *: string

The ID of the user in GUID format

Related Operations:

access-management#listMembers.$.id

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

Invalid ID or this user could not be removed from the org

The organization does not exist

Too many requests

List Owner listOwner

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

get owner for an organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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" }

Bad request; bad parameter or other failure

Forbidden; caller doesn't have the right permissions for specified action

Too many requests

Update Owner updateOwner

PUT

Try it out

Path Parameters

organizationId *

userId *

Custom Query Parameters

Custom Headers

Switch out organization's owner to the one specified by userId

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

userId *: string

The unique identifier of the user.

Related Operations:

access-management#listOwner.$.id

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" }

Bad request; bad parameter or other failure

Forbidden; caller doesn't have the right permissions for specified action

Too many requests

List Provider Users listProviderUsers

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Returns the identity provider details

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates the identity provider for the organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

identity_management *: any

idprovider_id: string

Response

Success

Delete Provider Users deleteProviderUsers

DELETE

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Revert to using the default identity provider

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Success

Create Ldap Test createLdapTest

POST

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

To test the ldap identity provider configuration before persisting

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

identity_management *: object

Response

Success

List Provider Users Saml Sp Metadata listProviderUsersSamlSpMetadata

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Download the SAML SP metadata

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Success

Create Proxyusers createProxyusers

POST

Try it out

Path Parameters

organizationId *

userId *

Custom Query Parameters

Custom Headers

Creates a proxy user in an organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

Query Parameters

displayProviderId

Custom Query Parameters

Custom Headers

Returns all role groups that belong to this organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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 }

The organization does not exist

Too many requests

Create Rolegroups createRolegroups

POST

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Creates a role group for this org

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Deletes role groups that belong to this organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

roleGroupId *

Query Parameters

displayProviderId

Custom Query Parameters

Custom Headers

Returns a role group

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

roleGroupId *: string

GUID of the organization role group

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

roleGroupId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates a role group

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

roleGroupId *: string

GUID of the organization role group

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

role_group_id: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

name: string

minLength: 1, maxLength: 255

description: string

minLength: 1, maxLength: 255

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

organizationId *

roleGroupId *

Custom Query Parameters

Custom Headers

Deletes a role group

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

roleGroupId *: string

GUID of the organization role group

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Success

List Rolegroups Roles listRolegroupsRoles

GET

Try it out

Path Parameters

organizationId *

roleGroupId *

Query Parameters

namepace

Custom Query Parameters

Custom Headers

Returns all roles assigned to this role group

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

roleGroupId *: string

GUID of the organization role group

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

roleGroupId *

Custom Query Parameters

Custom Headers

Request Body application/json

Assigns roles to this role group

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

roleGroupId *: string

GUID of the organization role group

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

roleGroupId *

Custom Query Parameters

Custom Headers

Request Body application/json

Removes roles from this role group

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

roleGroupId *: string

GUID of the organization role group

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

roleGroupId *

Custom Query Parameters

Custom Headers

Returns users assigned to this role group

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

roleGroupId *: string

GUID of the organization role group

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

roleGroupId *

Custom Query Parameters

Custom Headers

Request Body application/json

Assigns a group of users to this role group

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

roleGroupId *: string

GUID of the organization role group

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

roleGroupId *

Custom Query Parameters

Custom Headers

Request Body application/json

Unassigns a group of users from this role group

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

roleGroupId *: string

GUID of the organization role group

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

Could not unassign role group

Too many requests

Add User To Organization Rolegroup addUserToOrganizationRolegroup

POST

Try it out

Path Parameters

organizationId *

roleGroupId *

userId *

Custom Query Parameters

Custom Headers

Assigns this user to the role group

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

roleGroupId *: string

GUID of the organization role group

Related Operations:

access-management#listRolegroupsUsers.$.id

userId *: string

GUID of the user to assign

Related Operations:

Response

Success

Remove User From Organization Rolegroup removeUserFromOrganizationRolegroup

DELETE

Try it out

Path Parameters

organizationId *

roleGroupId *

userId *

Custom Query Parameters

Custom Headers

Removes this user from the role group

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

roleGroupId *: string

GUID of the organization role group

Related Operations:

access-management#listRolegroupsUsers.$.id

userId *: string

GUID of the user to assign

Related Operations:

Response

Success

Delete Roles deleteRoles

DELETE

Try it out

Path Parameters

organizationId *

Query Parameters

match *

<<contextParamName>> *

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

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

match *: string

Type of matching strategy to use for context matching. Use "exact" (default) to only remove assignments that have the exact set of given context parameter(s). Use "partial" to all remove assignments that contain the given context parameter(s).

<<contextParamName>> *: string

Target role assignments should have the context parameter name/value pair. At least one parameter that is not 'org' or 'envId' must be provided.

Response

Success

List Smtp listSmtp

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Returns the SMTP details

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates the SMTP details

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

Query Parameters

ancestor_team_id

team_id

parent_team_id

offset

ascending *

team_type

sort

limit

search

Custom Query Parameters

Custom Headers

Returns all teams or search for teams or get a list of teams by ids

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

ancestor_team_id: array

team_id that must appear in the team's ancestor_team_ids.

team_id: array

One or more ids of the team(s) to return. Type should be primitives.IdString but Osprey can't
handle custom types in query params

parent_team_id: array

team_id of the immediate parent of the team to return.

offset: integer

The number of records to omit from the response.

default: 0, min: 0

ascending *: boolean

Whether to sort ascending or descending

default: True

team_type: array

One or more types of team(s) to return. Type should be teams.TeamType but Osprey can't
handle custom types in query params

sort: string

The field to sort on.

default: team_name

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Creates a new team.

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

parent_team_id *: string

The team_id of the parent of this team.

minLength: 1, maxLength: 255

team_name *: string

The name of the team. Name is unique among teams within the organization.

minLength: 1, maxLength: 255, pattern: ^[a-zA-Z\d\-_\s]+$

team_type *: string

The type of the team.
Internal teams are visible to all members of the organziation. All internal teams of an organization are under the root internal team.
Private teams are internal teams but are only visible by maintainers/members of the team.
Shared teams are internal teams that can be mapped to external teams in other organizations where a trust relationship has been formed.

Response

json

Success

team_id *: string

The id of the team. Team_id is globally unique.

minLength: 1, maxLength: 255

org_id *: string

The root organization id where the team is defined.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

org_name *: string

The name of the root organization that manages the team.

team_name *: string

The name of the team. Name is unique among teams within the organization.

minLength: 1, maxLength: 255, pattern: ^[a-zA-Z\d\-_\s]+$

team_type *: string

The type of the team.

external_org_id: string

For external teams, this is the root organization id where the members of this team are members.
For internal/private/shared teams, this field is not applicable/present.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

external_org_name: string

For external teams, this is the root organization's name where the members of this team are members.
For internal/private/shared teams, this field is not applicable/present.

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.

No team for the parent_team_id or the type of the parent_team_id is incompatible with this team's type.

Too many requests

Get Teams getTeams

GET

Try it out

Path Parameters

organizationId *

teamId *

Custom Query Parameters

Custom Headers

Returns the team

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

json

Success

team_id *: string

The id of the team. Team_id is globally unique.

minLength: 1, maxLength: 255

org_id *: string

The root organization id where the team is defined.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

org_name *: string

The name of the root organization that manages the team.

team_name *: string

The name of the team. Name is unique among teams within the organization.

minLength: 1, maxLength: 255, pattern: ^[a-zA-Z\d\-_\s]+$

team_type *: string

The type of the team.

external_org_id: string

For external teams, this is the root organization id where the members of this team are members.
For internal/private/shared teams, this field is not applicable/present.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

external_org_name: string

For external teams, this is the root organization's name where the members of this team are members.
For internal/private/shared teams, this field is not applicable/present.

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

organizationId *

teamId *

Custom Query Parameters

Custom Headers

Request Body application/json

Update or move the team

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

team_name: string

The name of the team. Name is unique among teams within the organization.

minLength: 1, maxLength: 255, pattern: ^[a-zA-Z\d\-_\s]+$

team_type: string

The type of the team.
Internal teams are visible to all members of the organziation. All internal teams of an organization are under the root internal team.
Private teams are internal teams but are only visible by maintainers/members of the team.
Shared teams are internal teams that can be mapped to external teams in other organizations where a trust relationship has been formed.
If the parent team is external, this team must be external. If the parent team is private, this team must be private. If a child team is not private, this team can not be private

Response

json

Success

team_id *: string

The id of the team. Team_id is globally unique.

minLength: 1, maxLength: 255

org_id *: string

The root organization id where the team is defined.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

org_name *: string

The name of the root organization that manages the team.

team_name *: string

The name of the team. Name is unique among teams within the organization.

minLength: 1, maxLength: 255, pattern: ^[a-zA-Z\d\-_\s]+$

team_type *: string

The type of the team.

external_org_id: string

For external teams, this is the root organization id where the members of this team are members.
For internal/private/shared teams, this field is not applicable/present.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

external_org_name: string

For external teams, this is the root organization's name where the members of this team are members.
For internal/private/shared teams, this field is not applicable/present.

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.

Not Authorized to either update the properties on the team.

If changing the name and the new name is already used by other team in the organization.
If changing the type and the new type is incompatible with the parent's or a child's type.

Too many requests

Delete Teams deleteTeams

DELETE

Try it out

Path Parameters

organizationId *

teamId *

Custom Query Parameters

Custom Headers

Delete the team, including all child teams.

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Success.

Update Teams Parent updateTeamsParent

PUT

Try it out

Path Parameters

organizationId *

teamId *

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

The ID of the organization in GUID format

Related Operations:

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

parent_team_id *: string

The id of the new parent team to move this team under. Specifying a new parent_team_id will move this team.
parent_team_id can only be changed if the user has permissions and the type constraints are allowed.

minLength: 1, maxLength: 255

Response

json

Success

team_id *: string

The id of the team. Team_id is globally unique.

minLength: 1, maxLength: 255

org_id *: string

The root organization id where the team is defined.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

org_name *: string

The name of the root organization that manages the team.

team_name *: string

The name of the team. Name is unique among teams within the organization.

minLength: 1, maxLength: 255, pattern: ^[a-zA-Z\d\-_\s]+$

team_type *: string

The type of the team.

external_org_id: string

For external teams, this is the root organization id where the members of this team are members.
For internal/private/shared teams, this field is not applicable/present.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

external_org_name: string

For external teams, this is the root organization's name where the members of this team are members.
For internal/private/shared teams, this field is not applicable/present.

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.

Not Authorized to move the team or move the team under the new parent_team_id

If no team exists for the parent_team_id or the type of the parent_team_id is incompatible with this team's type.

Too many requests

List Teams Groupmappings listTeamsGroupmappings

GET

Try it out

Path Parameters

organizationId *

teamId *

Query Parameters

membership_type?

offset

limit

search

Custom Query Parameters

Custom Headers

get all group access mappings configured for the team

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

The number of records to omit from the response.

default: 0, min: 0

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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

organizationId *

teamId *

Custom Query Parameters

Custom Headers

Request Body application/json

Replace the entire list of group mappings associated with this team

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

items: array

Array items

Response

Success

Update Organization Team Groupmappings updateOrganizationTeamGroupmappings

PATCH

Try it out

Path Parameters

organizationId *

teamId *

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

The ID of the organization in GUID format

Related Operations:

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

items: array

Array items

Response

Success

Delete Teams Groupmappings deleteTeamsGroupmappings

DELETE

Try it out

Path Parameters

organizationId *

teamId *

Custom Query Parameters

Custom Headers

Request Body application/json

bulk remove mappings from the team

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

items: array

Array items

Response

Success.

List Teams Roles listTeamsRoles

GET

Try it out

Path Parameters

organizationId *

teamId *

Query Parameters

role_id

search

offset

limit

Custom Query Parameters

Custom Headers

get all role assignments or search for role assignments

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

The number of records to omit from the response.

default: 0, min: 0

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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

organizationId *

teamId *

Custom Query Parameters

Custom Headers

Request Body application/json

bulk assign roles to the team

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

items: array

Array items

Response

Success

Invalid role_id or context_parameters.

Too many requests

Delete Teams Roles deleteTeamsRoles

DELETE

Try it out

Path Parameters

organizationId *

teamId *

Custom Query Parameters

Custom Headers

Request Body application/json

bulk unassign roles from the team

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

items: array

Array items

Response

Success

Invalid role_id or context_parameters.

Too many requests

List Teams Members listTeamsMembers

GET

Try it out

Path Parameters

organizationId *

teamId *

Query Parameters

membership_type

identity_type

displayUserDetails

member_ids

offset

ascending *

sort

limit

search

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

The ID of the organization in GUID format

Related Operations:

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

membership_type: array

Include the members of the team that have this membership_type.
By default, all types of members are returned.

identity_type: array

Include the members of the team that have this type.
By default, all types of members are returned.

displayUserDetails: boolean

If true, include additional user fields. Only compatible with the user identity_type

default: False

member_ids: array

Include the members of the team that have ids in this list

offset: integer

The number of records to omit from the response.

default: 0, min: 0

ascending *: boolean

Whether to sort ascending or descending

default: True

sort: string

The field to sort on.

default: identity_type

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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

organizationId *

teamId *

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

The ID of the organization in GUID format

Related Operations:

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

items: array

Array items

Response

Success

Returned if any member id is for a team. Use the endpoints directly on the team to move it or delete it.

Too many requests

Delete Teams Members deleteTeamsMembers

DELETE

Try it out

Path Parameters

organizationId *

teamId *

Custom Query Parameters

Custom Headers

Request Body application/json

bulk remove user members from the team

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

items: array

Array items

Response

Success.

Returned if any member id is for a team. Use the endpoints directly on the team to move it or delete it.

Too many requests

Update Organization Team Member updateOrganizationTeamMember

PUT

Try it out

Path Parameters

organizationId *

teamId *

userId *

Custom Query Parameters

Custom Headers

Request Body application/json

add the user as a member of the team.

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listTeamsMembers.$.data[*].id

userId *: string

user id

minLength: 1, maxLength: 255

Related Operations:

Request Body

json

membership_type *: string

Whether the member is a regular member or a maintainer. Only users may be team maintainers.

Response

Success.

Returned if the member id is for a team. Use the endpoints directly on the team to move it or delete it.

Too many requests

Remove Organization Team Member removeOrganizationTeamMember

DELETE

Try it out

Path Parameters

organizationId *

teamId *

userId *

Custom Query Parameters

Custom Headers

remove the user from the team.

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

teamId *: string

id of the team

minLength: 1, maxLength: 255

Related Operations:

access-management#listTeamsMembers.$.data[*].id

userId *: string

user id

minLength: 1, maxLength: 255

Related Operations:

Response

Success.

Returned if the member id is for a team. Use the endpoints directly on the team to move it or delete it.

Too many requests

List Tenant Relationships listTenantRelationships

GET

Try it out

Path Parameters

organizationId *

Query Parameters

enabled

incomingTrust

offset

outgoingTrust

ascending *

rel_type

tenantKey

sort

limit

Custom Query Parameters

Custom Headers

List Tenant Relationships by Root Organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

enabled: boolean

Used to filter by whether tenant relationship is enabled

incomingTrust: string

Used to filter by incoming trust value

offset: integer

The number of records to omit from the response.

default: 0, min: 0

outgoingTrust: string

Used to filter by outgoing trust value

ascending *: boolean

Whether to sort ascending or descending

default: True

rel_type: array

Used to filter by type of Tenant Relationship

tenantKey: array

Used to filter by tenantKey value

sort: string

The field to sort on.

default: label

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

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

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Establish manual tenant relationships

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

id *: string

The ID of the Tenant Relationship

minLength: 1, maxLength: 255

organization *: object

Data describing the Root Organization associated with the Tenant Relationship

type *: string

The type of the Tenant Relationship

enabled *: boolean

Whether the Tenant Relationship is currently enabled

tenantKey *: string

The unique ID of the remote tenant. For SFDC_C2C type relationships, this will be a valid GDoT Tenant GUID value

minLength: 1, maxLength: 150

label *: string

Unique human-friendly name / label for the Tenant Relationship

sources *: array

Description of the sources of the Tenant Relationship. i.e. whether the Relationship is provisioned or manually created.

createdAt *: string(date-time)

The date/time the Tenant Relationship was created

updatedAt *: string(date-time)

The date/time the Tenant Relationship was last updated

config *: object

Additional type-specific configuration

Get Tenant Relationships getTenantRelationships

GET

Try it out

Path Parameters

organizationId *

relationshipId *

Custom Query Parameters

Custom Headers

Get a particular Tenant Relationship by ID

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

relationshipId *: string

id of the Tenant Relationship

minLength: 1, maxLength: 255

Response

json

Success

tenantRelationship *: object

id *: string

The ID of the Tenant Relationship

minLength: 1, maxLength: 255

organization *: object

Data describing the Root Organization associated with the Tenant Relationship

type *: string

The type of the Tenant Relationship

enabled *: boolean

Whether the Tenant Relationship is currently enabled

tenantKey *: string

The unique ID of the remote tenant. For SFDC_C2C type relationships, this will be a valid GDoT Tenant GUID value

minLength: 1, maxLength: 150

label *: string

Unique human-friendly name / label for the Tenant Relationship

sources *: array

Description of the sources of the Tenant Relationship. i.e. whether the Relationship is provisioned or manually created.

createdAt *: string(date-time)

The date/time the Tenant Relationship was created

updatedAt *: string(date-time)

The date/time the Tenant Relationship was last updated

config *: object

Additional type-specific configuration

Authentication Required

Not Authorized

No such Tenant Relationship

Update Tenant Relationships updateTenantRelationships

PATCH

Try it out

Path Parameters

organizationId *

relationshipId *

Custom Query Parameters

Custom Headers

Request Body application/json

Patch update a particular Tenant Relationship by ID

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

relationshipId *: string

id of the Tenant Relationship

minLength: 1, maxLength: 255

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

id *: string

The ID of the Tenant Relationship

minLength: 1, maxLength: 255

organization *: object

Data describing the Root Organization associated with the Tenant Relationship

type *: string

The type of the Tenant Relationship

enabled *: boolean

Whether the Tenant Relationship is currently enabled

tenantKey *: string

The unique ID of the remote tenant. For SFDC_C2C type relationships, this will be a valid GDoT Tenant GUID value

minLength: 1, maxLength: 150

label *: string

Unique human-friendly name / label for the Tenant Relationship

sources *: array

Description of the sources of the Tenant Relationship. i.e. whether the Relationship is provisioned or manually created.

createdAt *: string(date-time)

The date/time the Tenant Relationship was created

updatedAt *: string(date-time)

The date/time the Tenant Relationship was last updated

config *: object

Additional type-specific configuration

Authentication Required

Not Authorized

No such Tenant Relationship

Delete Tenant Relationships deleteTenantRelationships

DELETE

Try it out

Path Parameters

organizationId *

relationshipId *

Custom Query Parameters

Custom Headers

Delete a particular Tenant Relationship by ID

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

relationshipId *: string

id of the Tenant Relationship

minLength: 1, maxLength: 255

Response

Success

Authentication Required

Not Authorized

No such Tenant Relationship

Update Tenant Relationships Repair updateTenantRelationshipsRepair

PATCH

Try it out

Path Parameters

organizationId *

relationshipId *

Custom Query Parameters

Custom Headers

Repairs certain types of connection errors between the MuleSoft org and the remote Tenant

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

relationshipId *: string

id of the Tenant Relationship

minLength: 1, maxLength: 255

Response

Success

Bad Request

Authentication Required

Not Authorized

No such Tenant Relationship

Too many requests

Update My Tenant Relationship Status updateMyTenantRelationshipStatus

PUT

Try it out

Path Parameters

organizationId *

statusKey *

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

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

{}

Bad Request

Authentication Required

Not Authorized

Too many requests

List My Tenant Relationship Assignments listMyTenantRelationshipAssignments

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Get business group assignments for the Tenant Relationship for the caller utilizing a C2C token

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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 }

Authentication Required

Not Authorized

Too many requests

List Users listUsers

GET

Try it out

Path Parameters

organizationId *

Query Parameters

type *

mfaVerificationExcluded *

search

deleted *

Custom Query Parameters

Custom Headers

Returns a group of users that belong to the organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

type *: string

Specify the type of user you want to retrieve.

default: host

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

Specify if you want to retrieve only deleted

default: False

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 }

Organization does not exist

Too many requests

Create Users createUsers

POST

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Create a single user under the organization

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

Organization does not exist

Username already exists

Too many requests

Update Users updateUsers

PUT

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Update a group of users

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

Invalid data in body or not all users are part of the specified org

Organization does not exist

Too many requests

Delete Users deleteUsers

DELETE

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Deletes a group of users

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

Organization does not exist

Too many requests

Get Users getUsers

GET

Try it out

Path Parameters

organizationId *

userId *

Custom Query Parameters

Custom Headers

Returns a single user

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

userId *: string

The ID of the user in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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.

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.

ownerId *: string

The unique identifier of the user who owns the resource.

updatedAt *: string

The date and time when the resource was last updated, in ISO 8601 format.

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.

properties *: object

Additional properties associated with the resource.

entitlements *: object

The features and capabilities the organization is entitled to use.

isFederated *: boolean

Whether the organization uses a federated identity provider for authentication.

isRoot *: boolean

Whether the organization is the root organization in the hierarchy.

isMaster *: boolean

Whether the organization is the master organization.

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.

subscription *: object

The subscription that controls the entitlements available to the organization.

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": {} }

User does not exist

Too many requests

Update Organization User updateOrganizationUser

PUT

Try it out

Path Parameters

organizationId *

userId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates a single user. Modifying email may require reauthentication.

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

userId *: string

The ID of the user in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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.

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.

ownerId *: string

The unique identifier of the user who owns the resource.

updatedAt *: string

The date and time when the resource was last updated, in ISO 8601 format.

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.

properties *: object

Additional properties associated with the resource.

entitlements *: object

The features and capabilities the organization is entitled to use.

isFederated *: boolean

Whether the organization uses a federated identity provider for authentication.

isRoot *: boolean

Whether the organization is the root organization in the hierarchy.

isMaster *: boolean

Whether the organization is the master organization.

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.

subscription *: object

The subscription that controls the entitlements available to the organization.

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": {} }

Reauthentication required.

Invalid data in body

Reauthentication required. See location link

error *: string

Error information returned with the response.

location *: string

The geographic location associated with the resource.

Examples

application/json

{ "error": "You must reauthenticate", "location": "/login/?reauthenticate=true" }

User does not exist

Too many requests

Delete Organization User deleteOrganizationUser

DELETE

Try it out

Path Parameters

organizationId *

userId *

Custom Query Parameters

Custom Headers

Deletes a user

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

userId *: string

The ID of the user in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Success

User does not exist

Custom Query Parameters

Custom Headers

Request Body application/json

Updates an existing users properties in the platform user directory.

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

userId *: string

The ID of the user in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

userId *

Custom Query Parameters

Custom Headers

Returns the role groups assigned to the user

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

userId *: string

The ID of the user in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

userId *

roleGroupId *

Custom Query Parameters

Custom Headers

Assigns the role group to the user

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

userId *: string

The ID of the user in GUID format

Related Operations:

access-management#listUsersRolegroups.$.id

roleGroupId *: string

The ID of the role group in GUID format

Related Operations:

Response

Success

Delete Users Rolegroups deleteUsersRolegroups

DELETE

Try it out

Path Parameters

organizationId *

userId *

roleGroupId *

Custom Query Parameters

Custom Headers

Unassigns the role group from the user

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

userId *: string

The ID of the user in GUID format

Related Operations:

access-management#listUsersRolegroups.$.id

roleGroupId *: string

The ID of the role group in GUID format

Related Operations:

Response

Success

List Users Roles listUsersRoles

GET

Try it out

Path Parameters

organizationId *

userId *

Query Parameters

role_groups

teams

namespace

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

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

userId *: string

The ID of the user in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

userId *

Custom Query Parameters

Custom Headers

Request Body application/json

Bulk assign roles to the user

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

userId *: string

The ID of the user in GUID format

Related Operations:

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

access-management#listUsersRoles.$.id

roleId *: string

The ID of the role in GUID format

Related Operations:

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

organizationId *

userId *

Query Parameters

ancestor_team_id

membership_type

parent_team_id

offset

ascending *

team_type

sort

limit

search

Custom Query Parameters

Custom Headers

Returns a list of teams the user is a member of

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

userId *: string

The ID of the user in GUID format

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

The number of records to omit from the response.

default: 0, min: 0

ascending *: boolean

Whether to sort ascending or descending

default: True

team_type: array

return only teams that are of this type

sort: string

The field to sort on.

default: team_name

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

search: string

A search string to use for case-insensitive partial matches on team name

Response

json

Success

data *: array

Response payload for listUsersIdentityProviderProfiles.

idpUserId *: string(email)

The identifier of the user as recorded in the external identity provider.

idpUserName *: null

The username of the user as recorded in the external identity provider.

userId *: string

The unique identifier of the user.

providerId *: string

The unique identifier of the identity provider.

loginProfileData *: string(email)

Profile data captured during the most recent login.

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.

isFederated *: boolean

Whether the organization uses a federated identity provider for authentication.

lastLoginAt *: string

The date and time of the user's most recent successful login, in ISO 8601 format.

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

organizationId *

userId *

Custom Query Parameters

Custom Headers

Request Body application/json

Removes an identity provider profile from a user

Path Parameters

organizationId *: string

The ID of the organization in GUID format

Related Operations:

userId *: string

The ID of the user in GUID format

Related Operations:

access-management#listRoles.$.id

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.

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.

entitlements *: object

The features and capabilities the organization is entitled to use.

owner *: object

The user or entity that owns the resource.

subscription *: object

The subscription that controls the entitlements available to the organization.

environments *: array

The environments configured for the organization.

salesforce *: object

Configuration of the Salesforce integration for the organization.

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 } } }

Unauthorized. There is no user attached to the token

Too many requests

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

Bad request; missing username parameter

Too many requests

List Recover Password listRecoverPassword

GET

Try it out

Path Parameters

recoverCode *

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

the code does not exist

Too many requests

Create Recover Password By Code createRecoverPasswordByCode

POST

Try it out

Path Parameters

recoverCode *

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

minLength: 6

confirmPassword *: string

minLength: 6

Examples

application/json

{ "password": "Password1", "confirmPassword": "Password1" }

Response

the password was successfully reset

any of the code, password or confirmPassword are missing or password and confirmPassword do not match

the code does not exist

Too many requests

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

Bad request; missing email parameter

Too many requests

List Roles listRoles

GET

Try it out

Query Parameters

name

description

include_internal

offset

limit

search

sort

ascending *

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

Include internal roles

default: False

offset: integer

The number of records to omit from the response.

default: 0, min: 0

limit: integer

Maximum records to retrieve per request.

default: 25, min: 0, max: 500

search: string

A search string to use for case-insensitive partial matches on role names

sort: string

The field to sort on.

default: name

ascending *: boolean

Whether to sort ascending or descending

default: True

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

roleId *

Custom Query Parameters

Custom Headers

Returns a single role by ID

Path Parameters

roleId *: string

The ID of the role in GUID format

Related Operations:

Response

Success

List Roles Users listRolesUsers

GET

Try it out

Path Parameters

roleId *

Custom Query Parameters

Custom Headers

Returns users for a single role. This endpoint is rate lmited.

Path Parameters

roleId *: string

The ID of the role in GUID format

Related Operations:

access-management#listRoles.$.id

Response

Success

List Roles Permissions listRolesPermissions

GET

Try it out

Path Parameters

roleId *

Custom Query Parameters

Custom Headers

List permissions assigned to a given role

Path Parameters

roleId *: string

The ID of the role in GUID format

Related Operations:

access-management#listRoles.$.id

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

include_inherited

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

role_groups *

teams *

Custom Query Parameters

Custom Headers

Retrieve users by roles

Query Parameters

role_groups *: boolean

Flag that indicates if we should include role groups assignments when looking for the role

default: False

teams *: boolean

Flag that indicates if we should include team role assignments when looking for the role

default: False

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

code *

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 }

Missing or invalid invite code

Too many requests

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.

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.

ownerId *: string

The unique identifier of the user who owns the resource.

updatedAt *: string

The date and time when the resource was last updated, in ISO 8601 format.

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.

properties *: object

Additional properties associated with the resource.

entitlements *: object

The features and capabilities the organization is entitled to use.

isFederated *: boolean

Whether the organization uses a federated identity provider for authentication.

isRoot *: boolean

Whether the organization is the root organization in the hierarchy.

isMaster *: boolean

Whether the organization is the master organization.

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.

subscription *: object

The subscription that controls the entitlements available to the organization.

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": {} }

Bad request; invalid or missing fields; username, password, email, firstName, lastName or user already exists, etc.

Request from forbidden country

Conflict - User already exists

Too many requests

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.

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.

ownerId *: string

The unique identifier of the user who owns the resource.

updatedAt *: string

The date and time when the resource was last updated, in ISO 8601 format.

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.

properties *: object

Additional properties associated with the resource.

entitlements *: object

The features and capabilities the organization is entitled to use.

isFederated *: boolean

Whether the organization uses a federated identity provider for authentication.

isRoot *: boolean

Whether the organization is the root organization in the hierarchy.

isMaster *: boolean

Whether the organization is the master organization.

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.

subscription *: object

The subscription that controls the entitlements available to the organization.

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

db *

replicas *

arc *

keys *

ld *

all *

Custom Query Parameters

Custom Headers

Retrieves the health of the application.

Query Parameters

db *: boolean

Flag that indicates if we should perform a root DB connection check or not as part of the healthcheck.

default: False

replicas *: boolean

Flag that indicates if we should check all replica DB connections or not as part of the healthcheck.

default: False

arc *: boolean

Flag that indicates if we should check if ARC (Anypoint Roles Clients) is loaded as part of the healthcheck.

default: False

keys *: boolean

Flag that indicates if we should check if the JWKS key store is loaded as part of the healthcheck.

default: False

ld *: boolean

Flag that indicates if we should check if the LaunchDarkly client is initialized as part of the healthcheck.

default: False

all *: boolean

Flag that indicates if we should perform all registered checks

default: False

Response

json

Everything is working ok.

status *: string

The current status of the resource.

Examples

application/json

{ "status": "ok" }

Too many requests

The application isn't working properly, and shouldn't accept incoming requests.

status *: string

The current status of the resource.

Examples

application/json

{ "status": "quiesced" }

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

Too many requests

Support portal not available or an unknown error occurred

Get Username getUsername

GET

Try it out

Path Parameters

username *

Custom Query Parameters

Custom Headers

Check if the username is already taken

Path Parameters

username *: string

Username to search

Response

Username exists

Username if available

Too many requests

List All Users listAllUsers

GET

Try it out

Query Parameters

deleted *

type *

mfaVerificationExcluded *

Custom Query Parameters

Custom Headers

Returns a group of users

Query Parameters

deleted *: boolean

Specify if you want to retrieve only deleted

default: False

type *: string

Specify the type of user you want to retrieve.

default: host

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

Invalid data in body

Too many requests

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

userId *

Custom Query Parameters

Custom Headers

Returns a single user

Path Parameters

userId *: string

The ID of the user in GUID format

Related Operations:

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.

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.

ownerId *: string

The unique identifier of the user who owns the resource.

updatedAt *: string

The date and time when the resource was last updated, in ISO 8601 format.

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.

properties *: object

Additional properties associated with the resource.

entitlements *: object

The features and capabilities the organization is entitled to use.

isFederated *: boolean

Whether the organization uses a federated identity provider for authentication.

isRoot *: boolean

Whether the organization is the root organization in the hierarchy.

isMaster *: boolean

Whether the organization is the master organization.

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.

subscription *: object

The subscription that controls the entitlements available to the organization.

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": {} }

User does not exist

Too many requests

Update User By Id updateUserById

PUT

Try it out

Path Parameters

userId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates a single user. Modifying email may require reauthentication.

Path Parameters

userId *: string

The ID of the user in GUID format

Related Operations:

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

Reauthentication required.

Invalid data in body

Reauthentication required. See location link

error *: string

Error information returned with the response.

location *: string

The geographic location associated with the resource.

Examples

application/json

{ "error": "You must reauthenticate", "location": "/login/?reauthenticate=true" }

User does not exist

Too many requests

Delete User By Id deleteUserById

DELETE

Try it out

Path Parameters

userId *

Custom Query Parameters

Custom Headers

Deletes a user

Path Parameters

userId *: string

The ID of the user in GUID format

Related Operations:

Response

Success

Create Users Banpassword createUsersBanpassword

POST

Try it out

Path Parameters

userId *

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

The ID of the user in GUID format

Related Operations:

Response

Success

Update User Properties updateUserProperties

PUT

Try it out

Path Parameters

userId *

Custom Query Parameters

Custom Headers

Request Body application/json

Update the properties of a user

Path Parameters

userId *: string

The ID of the user in GUID format

Related Operations:

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

userId *

Query Parameters

namepace

role_groups

teams

Custom Query Parameters

Custom Headers

Returns a list of roles assigned to the user

Path Parameters

userId *: string

The ID of the user in GUID format

Related Operations:

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

userId *

roleId *

Custom Query Parameters

Custom Headers

Assign a role to the user

Path Parameters

userId *: string

The ID of the user in GUID format

Related Operations:

access-management#listAllUserRoles.$.id

roleId *: string

The ID of the role in GUID format

Related Operations:

Response

Success

Remove Role From User removeRoleFromUser

DELETE

Try it out

Path Parameters

userId *

roleId *

Custom Query Parameters

Custom Headers

Unassign a role from the user

Path Parameters

userId *: string

The ID of the user in GUID format

Related Operations:

access-management#listAllUserRoles.$.id

roleId *: string

The ID of the role in GUID format

Related Operations:

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.

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.

ownerId *: string

The unique identifier of the user who owns the resource.

updatedAt *: string

The date and time when the resource was last updated, in ISO 8601 format.

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.

properties *: object

Additional properties associated with the resource.

entitlements *: object

The features and capabilities the organization is entitled to use.

isFederated *: boolean

Whether the organization uses a federated identity provider for authentication.

isRoot *: boolean

Whether the organization is the root organization in the hierarchy.

isMaster *: boolean

Whether the organization is the master organization.

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.

subscription *: object

The subscription that controls the entitlements available to the organization.

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": {} }

Unauthorized. There is no user attached to the token

Too many requests

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" }

Version information could not be gathered (likely a filesystem error). See logs for details.

Too many requests

List V2Oauth2Authorize listV2Oauth2Authorize

GET

Try it out

Query Parameters

client_id

scope

state

redirect_uri

response_type

nonce

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

Bad request; an invalid redirect_uri, response_type or client_id

Too many requests

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

Bad request; an invalid redirect_uri, response_type or client_id

Too many requests

List V2Oauth2Authorize By Domain listV2Oauth2AuthorizeByDomain

GET

Try it out

Path Parameters

domain *

Query Parameters

nonce

state

scope

redirect_uri

client_id

response_type

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

Bad request; an invalid redirect_uri, response_type or client_id

Too many requests

Create V2Oauth2Authorize By Domain createV2Oauth2AuthorizeByDomain

POST

Try it out

Path Parameters

domain *

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

Bad request; an invalid redirect_uri, response_type or client_id

Too many requests

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

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

A hint about the type of the token submitted for introspection

default: access_token

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

A hint about the type of the token submitted for revocation

default: access_token

Response

Token was revoked successfully

Get V2Organization getV2Organization

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Retrieves details of v2.

Path Parameters

organizationId *: string

The id of the organization

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Delete V2Organization deleteV2Organization

DELETE

Try it out

Path Parameters

organizationId *

Query Parameters

force

Custom Query Parameters

Custom Headers

Deletes an existing v2.

Path Parameters

organizationId *: string

The id of the organization

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

force: boolean

If true, safety validations should be ignored

default: False

Response

Success

List V2Einstein Status listV2EinsteinStatus

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Get the org-wide Einstein status

Path Parameters

organizationId *: string

The id of the organization

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Set the org-wide Einstein status

Path Parameters

organizationId *: string

The id of the organization

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

enabled *: boolean

Response

Success

List V2Einstein Terms And Conditions listV2EinsteinTermsAndConditions

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Get the agreement status for einstein terms and conditions

Path Parameters

organizationId *: string

The id of the organization

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Toggle the agreement status for einstein terms and conditions

Path Parameters

organizationId *: string

The id of the organization

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

agree *: boolean

Response

Success

List V2Entitlements listV2Entitlements

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Retrieves a list of v2 entitlements.

Path Parameters

organizationId *: string

The id of the organization

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Sets one or more values for entitlements

Path Parameters

organizationId *: string

The id of the organization

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

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 } }

Resource does not exist

Too many requests

Get V2Entitlements getV2Entitlements

GET

Try it out

Path Parameters

organizationId *

entitlementName *

Custom Query Parameters

Custom Headers

Returns the name and value of the specified entitlement

Path Parameters

organizationId *: string

The id of the organization

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

entitlementName *: string

The name of the entitlement

Response

Returns entitlement

Examples

application/json

{ "createEnvironments": true }

Resource does not exists

Too many requests

Delete V2Environments deleteV2Environments

DELETE

Try it out

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

Custom Headers

Delete an environment

Path Parameters

organizationId *: string

The id of the organization

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The unique identifier of the environment.

Related Operations: