openapi: 3.0.0 info: title: Access Management API version: 1.0.0 description: Manage access control, identity, and authorization for the Anypoint Platform. Create and configure organizations, environments, role-based access control (RBAC), teams, connected applications (OAuth clients), identity providers, and client credentials. servers: - url: https://anypoint.mulesoft.com/accounts/api description: US - url: https://eu1.anypoint.mulesoft.com/accounts/api description: EU - url: https://ca1.platform.mulesoft.com/accounts/api description: CA - url: https://jp1.platform.mulesoft.com/accounts/api description: JP - url: https://in1.platform.mulesoft.com/accounts/api description: IN - url: https://au1.platform.mulesoft.com/accounts/api description: AU tags: - name: Access Management description: APIs for managing access control, identity, and authorization within the Anypoint Platform, including organizations, environments, RBAC, teams, connected applications, identity providers, and client credentials. - name: Identity Providers description: APIs for managing identity providers, including creation, configuration, and assignment to organizations and environments. - name: Organizations and Environments description: APIs for managing organizations and environments, including creation, configuration, and access control. - name: Role-Based Access Control (RBAC) description: APIs for managing role-based access control, including roles, permissions, and assignments to users and client applications. paths: /authorize: get: description: Authorize for a single resource parameters: - name: namespace required: true in: query schema: type: string description: The permission namespace to check authorization against (e.g., cloudhub, exchange). - name: action required: true in: query schema: type: string description: The action to authorize (e.g., GET, POST, PUT, DELETE). - name: resource required: true in: query schema: type: string description: The resource path to check authorization for. requestBody: content: application/json: example: namespace: namespace action: GET resource: /api schema: type: object description: 'Request payload for listAuthorize.' properties: namespace: type: string description: 'The permission namespace the operation applies to (for example, cloudhub or exchange).' action: type: string description: 'The action authorized by the operation (for example, GET, POST, PUT, DELETE).' resource: type: string description: 'The resource path the operation authorizes against.' required: - namespace - action - resource x-amf-mediaType: application/json description: Request payload for list authorize. responses: '200': description: '' '400': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Authorize a resource operationId: listAuthorize post: description: Authorize for many resources requestBody: content: application/json: example: namespace: namespace action: GET resources: - /api/users - /api/clients schema: type: object description: 'Request payload for createAuthorize.' properties: namespace: type: string description: 'The permission namespace the operation applies to (for example, cloudhub or exchange).' action: type: string description: 'The action authorized by the operation (for example, GET, POST, PUT, DELETE).' resources: type: array description: 'The list of resources affected by the request.' items: type: string description: 'The list of resources affected by the request.' required: - namespace - action - resources x-amf-mediaType: application/json description: Request payload for create authorize. responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: - /api/users - /api/clients schema: type: array description: 'Response payload for createAuthorize.' items: type: string description: 'Response payload for createAuthorize.' '400': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Authorize multiple resources operationId: createAuthorize /authorize/client: get: parameters: - name: client_id required: true in: query schema: type: string description: The unique identifier of the client application. - name: client_secret required: true in: query schema: type: string description: The secret credential for the client application. - name: namespace required: true in: query schema: type: string description: The permission namespace to check authorization against (e.g., cloudhub, exchange). - name: action required: true in: query schema: type: string description: The action to authorize (e.g., GET, POST, PUT, DELETE). - name: resource required: true in: query schema: type: string description: The resource path to check authorization for. requestBody: content: application/json: example: client_id: cid client_secret: secret namespace: namespace action: GET resource: /api schema: type: object description: 'Request payload for listAuthorizeClient.' properties: client_id: type: string description: 'The unique identifier of the client application.' client_secret: type: string description: 'The client secret used to authenticate the application when requesting tokens.' namespace: type: string description: 'The permission namespace the operation applies to (for example, cloudhub or exchange).' action: type: string description: 'The action authorized by the operation (for example, GET, POST, PUT, DELETE).' resource: type: string description: 'The resource path the operation authorizes against.' required: - client_id - client_secret - namespace - action - resource x-amf-mediaType: application/json description: Request payload for list authorize client. responses: '200': description: '' '400': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Authorize a client for a resource operationId: listAuthorizeClient description: Authorizes a client application for access to a specific resource using client credentials. /authorize/context: post: description: Get the set of contexts in which the caller can perform an action on resources that match a template requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthorizeContext' x-amf-mediaType: application/json description: Request payload for create authorize context. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/AuthorizeContextResult' total: type: number example: data: - namespace: cloudhub resource: /organizations/614b40bf-6eb6-49ac-82f4-d8332b6f4d1b/environments/a4685c7a-08fe-45d7-9e29-87b84223d251/applications resourceTemplate: /organizations/{{org}}/environments/{{envId}}/applications resourceTemplateParams: org: 614b40bf-6eb6-49ac-82f4-d8332b6f4d1b envId: a4685c7a-08fe-45d7-9e29-87b84223d251 actions: - GET - namespace: cloudhub resource: /organizations/614b40bf-6eb6-49ac-82f4-d8332b6f4d1b/environments/05e35d44-405a-4693-81ce-4e78e9a72891/applications resourceTemplate: /organizations/{{org}}/environments/{{envId}}/applications resourceTemplateParams: org: 614b40bf-6eb6-49ac-82f4-d8332b6f4d1b envId: 05e35d44-405a-4693-81ce-4e78e9a72891 actions: - GET - namespace: cloudhub resource: /organizations/d71ef2da-40cf-415b-80fd-eab0a7130bc8/environments/*/applications resourceTemplate: /organizations/{{org}}/environments/{{envId}}/applications resourceTemplateParams: org: d71ef2da-40cf-415b-80fd-eab0a7130bc8 envId: '*' actions: - GET total: 3 security: - bearerAuth: [] - clientAuth: [] summary: List contexts allowed for an action operationId: createAuthorizeContext /clients: description: 'Access to clients ' get: description: 'Get all clients ' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for listClients.' properties: ac_client: type: object description: 'The client used by the platform to perform authorization-code flows.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - redirect_uris - grant_types - properties - org_id rs_client: type: object description: 'The client used by the platform to perform resource-server operations.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - grant_types - properties - org_id ro_client: type: object description: 'The client used by the platform to perform resource-owner operations.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - grant_types - properties - org_id cc_client: type: object description: 'The client used by the platform to perform client-credentials flows.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - grant_types - properties - org_id im_client: type: object description: 'The client used by the platform to integrate with the identity manager.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - redirect_uris - grant_types - properties - org_id cp_client: type: object description: 'The client used by the platform to communicate with the control plane.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' org_id: type: string description: 'The unique identifier of the organization.' client_management_provider_id: type: string description: 'The unique identifier of the client management identity provider associated with the resource.' required: - client_id - name - redirect_uris - grant_types - org_id - client_management_provider_id required: - ac_client - rs_client - ro_client - cc_client - im_client - cp_client '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List clients operationId: listClients post: description: Create a new client requestBody: $ref: '#/components/requestBodies/Generated6' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for createClients.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - redirect_uris - grant_types - properties - org_id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create a client operationId: createClients /clients/{clientId}: description: 'Access to a client ' get: description: 'Get a single client ' parameters: - $ref: '#/components/parameters/XOrigin_clientId_Path' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for getClients.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - redirect_uris - grant_types - properties - org_id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get a client operationId: getClients patch: description: 'Patches a single client ' parameters: - name: resetSecret description: Asks service to reset secret as part of this operation required: true in: query schema: type: boolean - $ref: '#/components/parameters/XOrigin_clientId_Path' requestBody: $ref: '#/components/requestBodies/Generated7' responses: '200': description: '' '400': description: '' '404': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update a client operationId: updateClients delete: description: 'Deletes a single client ' parameters: - $ref: '#/components/parameters/XOrigin_clientId_Path' responses: '200': description: '' '400': description: '' '404': description: '' '409': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete a client operationId: deleteClients /clients/{clientId}/roles: description: Access to a client's roles get: description: Return a list of roles that are assigned to a client parameters: - $ref: '#/components/parameters/XOrigin_clientId_Path' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: - client_role_id: 40460a62-bbdc-469d-9330-5eec892abd05 role_id: 20460a62-bbdc-469d-9330-5eec892abd05 context_params: org: ms env: test schema: type: array description: 'Response payload for listClientsRoles.' items: type: object description: 'Response payload for listClientsRoles.' properties: client_role_id: type: string description: 'The unique identifier of the role assignment for the client.' role_id: type: string description: 'The unique identifier of the role.' context_params: type: object description: 'Additional parameters that scope the operation to a specific organization or environment.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' env: type: string description: 'The environment slug or short identifier used in API paths.' required: - org - env required: - client_role_id - role_id - context_params '400': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List roles assigned to a client operationId: listClientsRoles post: description: Assign a list of roles to a client parameters: - $ref: '#/components/parameters/XOrigin_clientId_Path' requestBody: $ref: '#/components/requestBodies/Generated5' responses: '200': description: '' '400': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Assign roles to a client operationId: createClientsRoles delete: description: Unassign a list of roles from a client parameters: - $ref: '#/components/parameters/XOrigin_clientId_Path' requestBody: $ref: '#/components/requestBodies/Generated5' responses: '200': description: '' '400': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Unassign roles from a client operationId: deleteClientsRoles /clients/{clientId}/roles/{roleId}: get: description: Return a role is assigned to a client parameters: - $ref: '#/components/parameters/XOrigin_clientId_Path' - $ref: '#/components/parameters/XOrigin_roleId_Path' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: - client_role_id: 40460a62-bbdc-469d-9330-5eec892abd05 role_id: 20460a62-bbdc-469d-9330-5eec892abd05 context_params: org: ms env: test schema: type: array description: 'Response payload for getClientsRoles.' items: type: object description: 'Response payload for getClientsRoles.' properties: client_role_id: type: string description: 'The unique identifier of the role assignment for the client.' role_id: type: string description: 'The unique identifier of the role.' context_params: type: object description: 'Additional parameters that scope the operation to a specific organization or environment.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' env: type: string description: 'The environment slug or short identifier used in API paths.' required: - org - env required: - client_role_id - role_id - context_params '400': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get a role assigned to a client operationId: getClientsRoles post: description: Assign a role to a client parameters: - $ref: '#/components/parameters/XOrigin_clientId_Path' - $ref: '#/components/parameters/XOrigin_roleId_Path' requestBody: $ref: '#/components/requestBodies/Generated3' responses: '200': description: '' '400': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Assign a role to a client operationId: createClientRole delete: description: Unassign a role from a client parameters: - $ref: '#/components/parameters/XOrigin_clientId_Path' - $ref: '#/components/parameters/XOrigin_roleId_Path' responses: '200': description: '' '400': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Unassign a role from a client operationId: deleteClientRole /clients/search: post: description: Search clients requestBody: content: application/json: schema: type: object properties: name: $ref: '#/components/schemas/stringOrArray' client_id: $ref: '#/components/schemas/stringOrArray' org_id: $ref: '#/components/schemas/stringOrArray' client_management_provider_id: $ref: '#/components/schemas/stringOrArray' example: client_id: - client1 - client2 x-amf-mediaType: application/json description: Request payload for create clients search. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: - 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 schema: type: array description: 'Response payload for createClientsSearch.' items: type: object description: 'Response payload for createClientsSearch.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - redirect_uris - grant_types - properties - org_id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Search clients operationId: createClientsSearch /connectedApplications: description: Access to connected applications get: description: Get all connected applications for the organization parameters: - name: includeUsage description: flag to indicate whether to return usage statistics required: true in: query schema: type: boolean default: false - $ref: '#/components/parameters/XOrigin_organizationId_Query' - name: hide_managed description: Hides the managed connected apps when set to true. in: query schema: type: boolean default: true - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 20 default: 20 - name: search description: A search string to use for case-insensitive partial matches on all object properties required: false in: query schema: type: string - name: sort description: The field to sort on. required: false in: query schema: type: string enum: - client_id - client_name default: client_name - name: ascending description: Whether to sort ascending or descending required: true in: query schema: type: boolean default: true responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for listConnectedApplications.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: client_id: type: string description: 'The unique identifier of the client application.' owner_org_id: type: string description: 'The unique identifier of the organization that owns the resource.' client_name: type: string description: 'The display name of the client application.' client_secret: type: string description: 'The client secret used to authenticate the application when requesting tokens.' public_keys: type: array description: 'The public keys used to verify signatures issued by the resource.' items: type: object redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' scopes: type: array description: 'The OAuth 2.0 scopes granted to the resource.' items: type: object enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' audience: type: string description: 'The audience (intended recipient) of the issued token, as defined by the OAuth 2.0 specification.' client_uri: type: 'null' description: 'URL of the homepage of the client application.' policy_uri: type: 'null' description: 'URL of the privacy policy of the client application.' tos_uri: type: 'null' description: 'URL of the terms of service of the client application.' generate_iss_claim_without_token: type: boolean description: 'Whether the issuer claim should be generated when no access token is present.' required: - client_id - owner_org_id - client_name - client_secret - public_keys - redirect_uris - grant_types - scopes - enabled - audience - client_uri - policy_uri - tos_uri - generate_iss_claim_without_token total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List connected applications operationId: listConnectedApplications post: description: Create a new connected application requestBody: $ref: '#/components/requestBodies/ConnectedApplicationCreate' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for createConnectedApplications.' properties: client_id: type: string description: 'The unique identifier of the client application.' owner_org_id: type: string description: 'The unique identifier of the organization that owns the resource.' client_name: type: string description: 'The display name of the client application.' client_secret: type: string description: 'The client secret used to authenticate the application when requesting tokens.' public_keys: type: array description: 'The public keys used to verify signatures issued by the resource.' items: type: object redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' scopes: type: array description: 'The OAuth 2.0 scopes granted to the resource.' items: type: object enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' audience: type: string description: 'The audience (intended recipient) of the issued token, as defined by the OAuth 2.0 specification.' generate_iss_claim_without_token: type: boolean description: 'Whether the issuer claim should be generated when no access token is present.' required: - client_id - owner_org_id - client_name - client_secret - public_keys - redirect_uris - grant_types - scopes - enabled - audience - generate_iss_claim_without_token '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create a connected application operationId: createConnectedApplications /connectedApplications/{clientId}: description: Access to individual connected application get: description: Get a single connected application parameters: - name: includeUsage description: flag to indicate whether to return usage statistics required: true in: query schema: type: boolean default: false - $ref: '#/components/parameters/XOrigin_connectedApplicationClientId_Path' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for getConnectedApplications.' properties: client_id: type: string description: 'The unique identifier of the client application.' owner_org_id: type: string description: 'The unique identifier of the organization that owns the resource.' client_name: type: string description: 'The display name of the client application.' client_secret: type: string description: 'The client secret used to authenticate the application when requesting tokens.' public_keys: type: array description: 'The public keys used to verify signatures issued by the resource.' items: type: object redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' scopes: type: array description: 'The OAuth 2.0 scopes granted to the resource.' items: type: object enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' audience: type: string description: 'The audience (intended recipient) of the issued token, as defined by the OAuth 2.0 specification.' generate_iss_claim_without_token: type: boolean description: 'Whether the issuer claim should be generated when no access token is present.' required: - client_id - owner_org_id - client_name - client_secret - public_keys - redirect_uris - grant_types - scopes - enabled - audience - generate_iss_claim_without_token '404': description: Connected application with that clientId could not be found '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get a connected application operationId: getConnectedApplications patch: description: Patches a single connected application parameters: - name: resetSecret description: Asks service to reset secret as part of this operation in: query schema: type: boolean default: false - $ref: '#/components/parameters/XOrigin_connectedApplicationClientId_Path' requestBody: $ref: '#/components/requestBodies/ConnectedApplicationUpdate' responses: '200': description: Connected application was successfully updated x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for updateConnectedApplications.' properties: client_id: type: string description: 'The unique identifier of the client application.' owner_org_id: type: string description: 'The unique identifier of the organization that owns the resource.' client_name: type: string description: 'The display name of the client application.' client_secret: type: string description: 'The client secret used to authenticate the application when requesting tokens.' public_keys: type: array description: 'The public keys used to verify signatures issued by the resource.' items: type: object redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' scopes: type: array description: 'The OAuth 2.0 scopes granted to the resource.' items: type: object enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' audience: type: string description: 'The audience (intended recipient) of the issued token, as defined by the OAuth 2.0 specification.' generate_iss_claim_without_token: type: boolean description: 'Whether the issuer claim should be generated when no access token is present.' required: - client_id - owner_org_id - client_name - client_secret - public_keys - redirect_uris - grant_types - scopes - enabled - audience - generate_iss_claim_without_token '404': description: Connected application with that clientId could not be found '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update a connected application operationId: updateConnectedApplications delete: description: Deletes a single connected application parameters: - $ref: '#/components/parameters/XOrigin_connectedApplicationClientId_Path' responses: '204': description: Connected application was deleted '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete a connected application operationId: deleteConnectedApplications /connectedApplications/{clientId}/scopes: description: 'Routes for operationg upon context-aware scopes assigned directly to the client''s identity, only for use with the client_credentials grant type. Orthogonal to the set of scopes associated with user authorizations. ' get: description: Retrieves context-aware scopes assigned to the connected application parameters: - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - $ref: '#/components/parameters/XOrigin_connectedApplicationClientId_Path' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: data: - scope: example:scope context_params: org: 8b0b657c-91ca-420d-870a-08699094f5e4 envId: 7cc0463b-f7be-418d-8a64-84fbad13ab00 total: 1 schema: type: object description: 'Response payload for listConnectedApplicationsScopes.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: scope: type: string description: 'The OAuth 2.0 scope granted to the resource.' context_params: type: object description: 'Additional parameters that scope the operation to a specific organization or environment.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' envId: type: string description: 'The unique identifier of the environment.' required: - org - envId required: - scope - context_params total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List connected app scopes operationId: listConnectedApplicationsScopes put: description: Replaces the entire list of context-aware scopes assigned to the connected application parameters: - $ref: '#/components/parameters/XOrigin_connectedApplicationClientId_Path' requestBody: $ref: '#/components/requestBodies/Generated8' responses: '204': description: Connected application scopes were successfully replaced '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Replace connected app scopes operationId: updateConnectedApplicationsScopes patch: description: 'Assigns additional context-aware scopes to the connected application. Does not unassign any existing scopes. Duplicate entries are ignored. ' parameters: - $ref: '#/components/parameters/XOrigin_connectedApplicationClientId_Path' requestBody: $ref: '#/components/requestBodies/Generated9' responses: '204': description: Connected application scopes were successfully assigned '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Add scopes to connected app operationId: updateConnectedApplicationScopes delete: description: 'Unassigns context-aware scopes from the connected application. Scopes must exactly match in order to be removed. ' parameters: - $ref: '#/components/parameters/XOrigin_connectedApplicationClientId_Path' requestBody: $ref: '#/components/requestBodies/Generated8' responses: '204': description: Connected application scopes were successfully unassigned '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Remove scopes from connected app operationId: deleteConnectedApplicationsScopes /connectedApplications/{clientId}/revoke: delete: description: Revoke all access tokens and refresh tokens issued to the connected application parameters: - $ref: '#/components/parameters/XOrigin_connectedApplicationClientId_Path' responses: '204': description: All tokens were revoked successfully '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Revoke connected app tokens operationId: deleteConnectedApplicationsRevoke /deletedResources: description: find deleted resources /deletedResources/organizations: get: description: returns the deleted organizations parameters: - name: deletedBefore description: search for all organizations deleted before a certain date required: true in: query schema: type: string format: date-time-only - name: deletedAfter description: search for all organizations deleted after a certain date required: true in: query schema: type: string format: date-time-only - name: parentOrgId description: search for all organizations deleted that are children of the specified orgnization required: true in: query schema: type: string - name: organizationId description: search for the organization deleted required: true in: query schema: type: string x-origin: - api: urn:api:access-management operation: listMe name: rootOrg description: GET `/me`; use `user.organization.id` as the caller's primary Business Group GUID. values: $.user.organization.id labels: $.user.organization.name - api: urn:api:access-management operation: getOrganizations name: currentOrganization description: GET `/organizations/{organizationId}`; use `id` as the Business Group GUID for the current organization. values: $.id labels: $.name - api: urn:api:access-management operation: getOrganizations name: subOrganizations description: GET `/organizations/{organizationId}`; each value in `subOrganizationIds` is a valid child Business Group GUID. values: $.subOrganizationIds labels: $.name responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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-13 16:19:33.859000+00:00 total: 1 schema: type: object description: 'Response payload for listDeletedResources.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: org_id: type: string description: 'The unique identifier of the organization.' parent_organization_ids: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: string description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' environment_ids: type: array description: 'Identifiers of the environments associated with the resource.' items: type: string description: 'Identifiers of the environments associated with the resource.' deleted_at: type: string description: 'The date and time when the resource was deleted, in ISO 8601 format.' required: - org_id - parent_organization_ids - environment_ids - deleted_at total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List deleted organizations operationId: listDeletedResources /deletedResources/environments: get: description: returns the deleted environments parameters: - name: deletedBefore description: search for all environments deleted before a certain date required: true in: query schema: type: string format: date-time-only - name: deletedAfter description: search for all environments deleted after a certain date required: true in: query schema: type: string format: date-time-only - name: organizationId description: search for all environments deleted that are associated with the specified orgnization required: true in: query schema: type: string x-origin: - api: urn:api:access-management operation: listMe name: rootOrg description: GET `/me`; use `user.organization.id` as the caller's primary Business Group GUID. values: $.user.organization.id labels: $.user.organization.name - api: urn:api:access-management operation: getOrganizations name: currentOrganization description: GET `/organizations/{organizationId}`; use `id` as the Business Group GUID for the current organization. values: $.id labels: $.name - api: urn:api:access-management operation: getOrganizations name: subOrganizations description: GET `/organizations/{organizationId}`; each value in `subOrganizationIds` is a valid child Business Group GUID. values: $.subOrganizationIds labels: $.name - name: envId description: search for the environment deleted required: true in: query schema: type: string responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: data: - environment_id: 3b4ae07b-321d-4364-8e16-4bfsd936a7b7 organization_id: 2b4ae07b-321d-4364-8e16-4b655936a7b8 deleted_at: 2019-08-13 16:19:33.859000+00:00 deleted_through_org: true total: 1 schema: type: object description: 'Response payload for listDeletedResourcesEnvironments.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: environment_id: type: string description: 'The unique identifier of the environment.' organization_id: type: string description: 'The unique identifier of the organization.' deleted_at: type: string description: 'The date and time when the resource was deleted, in ISO 8601 format.' deleted_through_org: type: boolean description: 'Whether the resource was deleted as a side effect of the parent organization being deleted.' required: - environment_id - organization_id - deleted_at - deleted_through_org total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List deleted environments operationId: listDeletedResourcesEnvironments /environments: description: Environments resource /environments/{environmentId}: description: Environment by id get: description: Retrieves an environment by id parameters: - $ref: '#/components/parameters/XOrigin_environmentId_Path' responses: '200': description: Returns the environment x-amf-mediaType: application/json content: application/json: example: id: f0c9b011-980e-4928-9430-e60e3a97c043 organizationId: 70b3f7cb-614c-4276-b0cd-4f73db11602c name: Development isProduction: false type: sandbox clientId: abdf31490ba44484a1de789baf685e37 schema: type: object description: 'Response payload for getEnvironments.' properties: id: type: string description: 'The unique identifier of the resource.' organizationId: type: string description: 'The unique identifier of the organization.' name: type: string description: 'The display name of the resource.' isProduction: type: boolean description: 'Whether the environment is a production environment.' type: type: string description: 'The type of the resource.' clientId: type: string description: 'The unique identifier of the client application.' required: - id - organizationId - name - isProduction - type - clientId '404': description: No environment exists with that id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get an environment operationId: getEnvironments put: description: Update an environment, implemented as a patch. Note that only the name is allowed to be updated, isProduction and type can not. parameters: - $ref: '#/components/parameters/XOrigin_environmentId_Path' requestBody: content: application/json: example: name: FooBarEnv organizationId: f0c9b011-980e-4928-9430-e60e3a97c043 schema: type: object description: 'Request payload for updateEnvironments.' properties: name: type: string description: 'The display name of the resource.' organizationId: type: string description: 'The unique identifier of the organization.' required: - name - organizationId x-amf-mediaType: application/json description: Request payload for update environments. responses: '200': description: Returns the updated environment x-amf-mediaType: application/json content: application/json: example: id: f0c9b011-980e-4928-9430-e60e3a97c043 organizationId: 70b3f7cb-614c-4276-b0cd-4f73db11602c name: Development isProduction: false type: sandbox clientId: abdf31490ba44484a1de789baf685e37 schema: type: object description: 'Response payload for updateEnvironments.' properties: id: type: string description: 'The unique identifier of the resource.' organizationId: type: string description: 'The unique identifier of the organization.' name: type: string description: 'The display name of the resource.' isProduction: type: boolean description: 'Whether the environment is a production environment.' type: type: string description: 'The type of the resource.' clientId: type: string description: 'The unique identifier of the client application.' required: - id - organizationId - name - isProduction - type - clientId '404': description: No environment exists with that id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update an environment operationId: updateEnvironments /featureFlags/{featureFlagName}: parameters: - name: featureFlagName description: The name of the feature flag to evaluate. required: true in: path schema: type: string /featureFlags/{featureFlagName}/check: post: description: check a feature for a list or organizations parameters: - name: featureFlagName required: true in: path schema: type: string description: The name of the feature flag to evaluate. requestBody: content: application/json: schema: $ref: '#/components/schemas/FeatureFlagCheckOrgList' x-amf-mediaType: application/json description: Request payload for create feature flags check. responses: '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Check feature flag for organizations operationId: createFeatureFlagsCheck /featureFlags/{featureFlagName}/enabled: get: description: get all enabled featureFlags includes organizations and additional context parameters: - name: featureFlagName required: true in: path schema: type: string description: The name of the feature flag to evaluate. responses: '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List enabled feature flags operationId: listFeatureFlagsEnabled /invites: description: Invite people to join the organization get: description: get outstanding or expired invites that match the criteria parameters: - name: organizationId description: the id of the organization that the invites are for joining. required: true in: query schema: type: string x-origin: - api: urn:api:access-management operation: listMe name: rootOrg description: GET `/me`; use `user.organization.id` as the caller's primary Business Group GUID. values: $.user.organization.id labels: $.user.organization.name - api: urn:api:access-management operation: getOrganizations name: currentOrganization description: GET `/organizations/{organizationId}`; use `id` as the Business Group GUID for the current organization. values: $.id labels: $.name - api: urn:api:access-management operation: getOrganizations name: subOrganizations description: GET `/organizations/{organizationId}`; each value in `subOrganizationIds` is a valid child Business Group GUID. values: $.subOrganizationIds labels: $.name - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - name: search description: A search string to use for case-insensitive partial matches on invited emails required: false in: query schema: type: string - name: sort description: The field to sort on. required: false in: query schema: type: string enum: - invited_email - invited_at default: invited_email - name: ascending description: Whether to sort ascending or descending required: true in: query schema: type: boolean default: true responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/Invite' total: type: number example: data: - id: 520 code: f2e8dfab-6699-4889-831f-6dc6f8428cb0 invited_at: 2015-01-30 22: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-10 22: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 '400': description: Bad request; unknown organization, bad parameter or other failure '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List invites operationId: listInvites post: description: Invite a person to join the organization requestBody: $ref: '#/components/requestBodies/InviteNewList' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/InviteList' '400': description: Bad request; unknown organization, bad parameter or other failure '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Invite a user to the organization operationId: createInvites delete: description: Invite a person to join your organization requestBody: $ref: '#/components/requestBodies/InvitesIds' responses: '204': description: Success '400': description: Bad request; unknown organization, bad parameter or no invite was deleted '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete invites operationId: deleteInvites /invites/{inviteId}: description: Invite resource get: description: get an invite parameters: - name: inviteId description: The ID of the invite required: true in: path schema: type: integer responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/Invite' '400': description: Bad request; bad parameter or other failure '404': description: No invite exists in this organization for the given inviteId '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get an invite operationId: getInvites /invites/accept: get: description: Redirect to anypoint signin to accept an invite responses: '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Redirect to accept invite operationId: listInvitesAccept /invites/resend: description: Resend invites post: description: Resend a list of invites requestBody: $ref: '#/components/requestBodies/InvitesIds' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/InvitesResendResponse' '400': description: One or more of the invites are not in the organization or no invites were sent '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Resend invites operationId: createInvitesResend /login: description: login to the Anypoint Platform post: description: login to the Anypoint Platform requestBody: content: application/json: example: username: testUser password: Password1 schema: type: object description: 'Request payload for createLogin.' properties: username: type: string description: 'The username used to authenticate the user.' password: type: string description: 'The user''s password. Write-only.' required: - username - password x-amf-mediaType: application/json description: Request payload for create login. responses: '200': description: Returns the bearer token for the user's session x-amf-mediaType: application/json content: application/json: example: access_token: d127e2ec-a703-4e2a-8629-e9158804748b token_type: bearer schema: type: object description: 'Response payload for createLogin.' properties: access_token: type: string description: 'The OAuth 2.0 access token issued to the client.' token_type: type: string description: 'The type of the issued token (typically ''Bearer'').' required: - access_token - token_type '302': description: Success; redirect the user to the application they were trying to visit '401': description: Invalid username or password '403': description: The user is disabled and cannot login '418': description: The user belongs to the other platform x-amf-mediaType: application/json content: application/json: example: target: composer schema: type: object description: 'Response payload for createLogin.' properties: target: type: string description: 'The target of the operation.' required: - target '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Log in to Anypoint Platform operationId: createLogin /logout: description: logout of the Anypoint Platform get: description: destroy the user's session and logout from the Anypoint Platform responses: '200': description: Success; logout was called via ajax so no redirect '302': description: Success; logout was not called via ajax so redirect to the login page '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Log out of Anypoint Platform operationId: listLogout /me: description: all about the caller get: description: Retrieve information about the caller responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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-27 20:56:02.112000+00:00 updatedAt: 2014-12-17 15:57:40.250000+00:00 lastLogin: 2014-12-17 15:57:40.250000+00:00 previousLastLogin: 2014-12-16 15: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-27 20:56:02.125000+00:00 ownerId: a23c0943-1cc4-47f1-aea2-cb6c2c2fca6a updatedAt: 2015-01-29 18: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-27 20: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-27 20:56:02.125000+00:00 ownerId: a23c0943-1cc4-47f1-aea2-cb6c2c2fca6a updatedAt: 2015-01-29 18: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-27 20:56:02.125000+00:00 contributorOfOrganizations: - name: Mordue's Sundays testing id: 0a14e2fd-1cfe-4310-acbc-54bf93eb8420 createdAt: 2014-07-27 20:56:02.125000+00:00 ownerId: a23c0943-1cc4-47f1-aea2-cb6c2c2fca6a updatedAt: 2015-01-29 18: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-27 20:56:02.125000+00:00 properties: {} schema: type: object description: 'Response payload for listMe.' properties: client: type: object description: 'The client application associated with the resource.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: object grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' required: - client_id - name - redirect_uris - grant_types user: type: object description: 'The user associated with the resource.' properties: id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' previousLastLogin: type: string description: 'The date and time of the user''s previous successful login, in ISO 8601 format.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email phoneNumber: type: string description: 'The user''s phone number.' username: type: string description: 'The username used to authenticate the user.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' deleted: type: boolean description: 'Whether the resource has been marked as deleted.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' type: type: string description: 'The type of the resource.' organizationPreferences: type: object description: 'Per-organization user preferences.' properties: 0a14e2fd-1cfe-4310-acbc-54bf93eb8420: type: object description: 'Per-organization preferences keyed by organization id.' properties: defaultEnvironment: type: string description: 'The default environment selected by the user for this organization.' required: - defaultEnvironment required: - 0a14e2fd-1cfe-4310-acbc-54bf93eb8420 organizationId: type: string description: 'The unique identifier of the organization.' organization: type: object description: 'The organization that owns the resource.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: object tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object idprovider_id: type: string description: 'The unique identifier of the identity provider.' properties: type: object description: 'Additional properties associated with the resource.' properties: cs_auth: type: object description: 'Configuration for Anypoint Platform authentication settings.' properties: session_timeout: type: integer description: 'Length of an authenticated session before re-authentication is required, in milliseconds.' required: - session_timeout defaultAccessManagementUi: type: string description: 'The Access Management UI variant the organization defaults to.' required: - cs_auth - defaultAccessManagementUi subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration entitlements: type: object description: 'The features and capabilities the organization is entitled to use.' properties: partnersProduction: type: object description: 'Whether production capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned partnersSandbox: type: object description: 'Whether sandbox capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersProduction: type: object description: 'Whether B2B Trading Partner Manager production capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersSandbox: type: object description: 'Whether B2B Trading Partner Manager sandbox capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned createSubOrgs: type: boolean description: 'Whether the organization is allowed to create sub-organizations.' createEnvironments: type: boolean description: 'Whether the organization is allowed to create environments.' hybrid: type: object description: 'Whether hybrid deployments are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled globalDeployment: type: boolean description: 'Whether the entitlement allows global deployment of MuleSoft applications.' vCoresProduction: type: object description: 'Number of production vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresSandbox: type: object description: 'Number of sandbox vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresDesign: type: object description: 'Number of design-time vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned staticIps: type: object description: 'Number of static IPs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpcs: type: object description: 'Number of Anypoint VPCs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpns: type: object description: 'Number of VPN connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned networkConnections: type: object description: 'Number of network connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned workerLoggingOverride: type: object description: 'Whether the organization can override worker logging configuration.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled messaging: type: object description: 'Whether Anypoint MQ is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned mqMessages: type: object description: 'Number of Anypoint MQ messages included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqRequests: type: object description: 'Number of Anypoint MQ requests included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqAdvancedFeatures: type: object description: 'Whether Anypoint MQ advanced features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled objectStoreRequestUnits: type: object description: 'Number of Object Store request units included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn objectStoreKeys: type: object description: 'Number of Object Store keys included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn gateways: type: object description: 'Number of API gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned designCenter: type: object description: 'Whether Anypoint Design Center is available to the organization.' properties: mozart: type: boolean description: 'Whether MuleSoft Mozart is available to the organization.' api: type: boolean description: 'Per-API capacity included in the entitlement.' apiVisual: type: boolean description: 'Whether the visual API designer is available to the organization.' apiExample: type: boolean description: 'Whether API example projects are available to the organization.' required: - mozart - api - apiVisual - apiExample loadBalancer: type: object description: 'Number of dedicated load balancers available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned externalIdentity: type: boolean description: 'Whether the user belongs to an external identity provider.' autoscaling: type: boolean description: 'Whether deployment autoscaling is available to the organization.' armAlerts: type: boolean description: 'Whether Anypoint Runtime Manager alerts are available to the organization.' hybridInsight: type: boolean description: 'Whether Hybrid Insight is available to the organization.' hybridAutoDiscoverProperties: type: boolean description: 'Whether hybrid runtimes can auto-discover platform properties.' apis: type: object description: 'Per-API limits or counters defined for the entitlement.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiCatalog: type: object description: 'Whether the API catalog is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiMonitoring: type: object description: 'Whether API monitoring is available to the organization.' properties: schedules: type: integer description: 'Whether scheduled flows are available to the organization.' required: - schedules apiCommunityManager: type: object description: 'Whether Anypoint API Community Manager is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiExperienceHub: type: object description: 'Whether Anypoint API Experience Hub is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled monitoringCenter: type: object description: 'Whether Anypoint Monitoring Center is available to the organization.' properties: productSKU: type: integer description: 'The product SKU that identifies the entitlement.' rawStorageOverrideGB: type: integer description: 'Override for the raw storage allowance, in GB.' dataRegion: type: string description: 'The cloud region where data for this organization is stored.' productionUnits: type: integer description: 'Number of production units included in the entitlement.' preProductionUnits: type: integer description: 'Number of pre-production units included in the entitlement.' storageBase: type: integer description: 'Base storage allowance included with the entitlement, in GB.' storageAddOn: type: integer description: 'Additional storage capacity provisioned on top of the base allowance, in GB.' required: - productSKU - rawStorageOverrideGB - dataRegion - productionUnits - preProductionUnits - storageBase - storageAddOn apiQuery: type: object description: 'Whether API Query is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' productSKU: type: integer description: 'The product SKU that identifies the entitlement.' required: - enabled - productSKU apiQueryC360: type: object description: 'Whether API Query for Customer 360 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled rpa: type: object description: 'Whether MuleSoft RPA is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' active: type: boolean description: 'Whether the feature or resource is currently active.' composerVersion: type: string description: 'The version of MuleSoft Composer available to the organization.' required: - enabled - active - composerVersion idp: type: object description: 'Whether the organization can configure its own identity provider.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled AutomationCreditsDW: type: object description: 'Number of automation credits available to the organization in Data Warehouse units.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned apiGovernance: type: object description: 'Whether Anypoint API Governance is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' apisPerMonth: type: integer description: 'Number of APIs the organization is allowed to manage per month.' required: - enabled - apisPerMonth apiGovernanceDomain: type: object description: 'Whether the API Governance domain feature is available to the organization.' properties: domain: type: string description: 'The domain name associated with the organization.' required: - domain crowd: type: object description: 'Whether the Crowd developer experience is available to the organization.' properties: hideApiManagerDesigner: type: boolean description: 'Whether the legacy API Manager designer is hidden from the organization.' hideFormerApiPlatform: type: boolean description: 'Whether the former API Platform UI is hidden from the organization.' environments: type: boolean description: 'The environments configured for the organization.' required: - hideApiManagerDesigner - hideFormerApiPlatform - environments cam: type: object description: 'Whether Anypoint Connectivity Access Management (CAM) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled exchange2: type: object description: 'Whether Anypoint Exchange 2 features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' assetUsageAndEngagement: type: object description: 'Whether asset usage and engagement metrics are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - enabled - assetUsageAndEngagement crowdSelfServiceMigration: type: object description: 'Whether self-service migration to Crowd is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled kpiDashboard: type: object description: 'Whether the KPI dashboard is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled pcf: type: boolean description: 'Whether the Pivotal Cloud Foundry integration is available to the organization.' appViz: type: boolean description: 'Whether Anypoint Application Visualization is available to the organization.' workerClouds: type: object description: 'Whether MuleSoft worker clouds are available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned runtimeFabric: type: boolean description: 'Whether Anypoint Runtime Fabric is available to the organization.' serviceMesh: type: object description: 'Whether Anypoint Service Mesh is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled flexGateway: type: object description: 'Whether Anypoint Omni Gateway is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled managedGatewaySmall: type: object description: 'Number of small managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned managedGatewayLarge: type: object description: 'Number of large managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned rtfManagedGateway: type: object description: 'Number of Runtime Fabric managed gateways available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled runtimeFabricCloud: type: object description: 'Whether Anypoint Runtime Fabric (Cloud) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled composer: type: object description: 'Whether MuleSoft Composer is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' tasksPerMonth: type: integer description: 'Number of tasks the organization is allowed to run per month.' maxConnectors: type: integer description: 'Maximum number of connectors the organization is allowed to use.' unlimitedConnectors: type: boolean description: 'Whether the entitlement allows the use of an unlimited number of connectors.' isHyperAutomation: type: boolean description: 'Whether the entitlement applies to MuleSoft Hyperautomation.' required: - enabled - tasksPerMonth - maxConnectors - unlimitedConnectors - isHyperAutomation muleDxWebIde: type: object description: 'Whether the Mule DX web IDE is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxGenAI: type: object description: 'Whether Mule DX generative AI features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxEDA: type: object description: 'Whether Mule DX event-driven architecture features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled usageBasedPricing: type: object description: 'Whether usage-based pricing applies to the organization.' properties: muleRuntimeIntegration: type: object description: 'Whether Mule Runtime integration features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' flows: type: integer description: 'Flow-related limits associated with the entitlement.' messages: type: integer description: 'Per-message limits or counters defined for the entitlement.' throughput: type: integer description: 'Throughput limits defined for the entitlement.' required: - enabled - flows - messages - throughput required: - muleRuntimeIntegration usageBasedPricingLimits: type: object description: 'Limits that apply to the organization under usage-based pricing.' properties: cpu: type: object description: 'CPU resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra memory: type: object description: 'Memory resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra required: - cpu - memory highAvailability: type: object description: 'Whether the entitlement allows high-availability deployments.' properties: clustering: type: boolean description: 'Whether the entitlement allows clustered deployments.' required: - clustering cloudhub1: type: object description: 'Whether CloudHub 1.0 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled telemetryExporter: type: object description: 'Whether the telemetry exporter is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - partnersProduction - partnersSandbox - tradingPartnersProduction - tradingPartnersSandbox - createSubOrgs - createEnvironments - hybrid - globalDeployment - vCoresProduction - vCoresSandbox - vCoresDesign - staticIps - vpcs - vpns - networkConnections - workerLoggingOverride - messaging - mqMessages - mqRequests - mqAdvancedFeatures - objectStoreRequestUnits - objectStoreKeys - gateways - designCenter - loadBalancer - externalIdentity - autoscaling - armAlerts - hybridInsight - hybridAutoDiscoverProperties - apis - apiCatalog - apiMonitoring - apiCommunityManager - apiExperienceHub - monitoringCenter - apiQuery - apiQueryC360 - rpa - idp - AutomationCreditsDW - apiGovernance - apiGovernanceDomain - crowd - cam - exchange2 - crowdSelfServiceMigration - kpiDashboard - pcf - appViz - workerClouds - runtimeFabric - serviceMesh - flexGateway - managedGatewaySmall - managedGatewayLarge - rtfManagedGateway - runtimeFabricCloud - composer - muleDxWebIde - muleDxGenAI - muleDxEDA - usageBasedPricing - usageBasedPricingLimits - highAvailability - cloudhub1 - telemetryExporter isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' required: - name - id - createdAt - ownerId - updatedAt - clientId - domain - isFederated - parentOrganizationIds - subOrganizationIds - tenantOrganizationIds - idprovider_id - properties - subscription - entitlements - isRoot - isMaster memberOfOrganizations: type: array description: 'The organizations the user is a member of.' items: type: object description: 'The organizations the user is a member of.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object parentId: type: 'null' description: 'The unique identifier of the parent resource.' parentName: type: 'null' description: 'The display name of the parent resource.' subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: object tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object idprovider_id: type: string description: 'The unique identifier of the identity provider.' isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration required: - name - id - createdAt - ownerId - updatedAt - clientId - domain - isFederated - parentOrganizationIds - parentId - parentName - subOrganizationIds - tenantOrganizationIds - idprovider_id - isRoot - isMaster - subscription contributorOfOrganizations: type: array description: 'The organizations the user has contributor access to.' items: type: object description: 'The organizations the user has contributor access to.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object parentId: type: 'null' description: 'The unique identifier of the parent resource.' parentName: type: 'null' description: 'The display name of the parent resource.' subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: object tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object idprovider_id: type: string description: 'The unique identifier of the identity provider.' isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration required: - name - id - createdAt - ownerId - updatedAt - clientId - domain - isFederated - parentOrganizationIds - parentId - parentName - subOrganizationIds - tenantOrganizationIds - idprovider_id - isRoot - isMaster - subscription properties: type: object description: 'Additional properties associated with the resource.' properties: {} required: - id - createdAt - updatedAt - lastLogin - previousLastLogin - firstName - lastName - email - phoneNumber - username - enabled - deleted - idprovider_id - type - organizationPreferences - organizationId - organization - memberOfOrganizations - contributorOfOrganizations - properties required: - client - user '400': description: An unknown error occurred '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get caller information operationId: listMe /notifications: description: Make Anypoint Platform activity known to subscribers; think webhooks. post: description: Creates a new notifications. requestBody: content: application/json: example: type: api action: create organizationId: 0a14e2fd-1cfe-4310-acbc-54bf93eb8420 userId: a23c0943-1cc4-47f1-aea2-cb6c2c2fca6a dateTime: 2014-07-27 20: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' schema: type: object description: 'Request payload for createNotifications.' properties: type: type: string description: 'The type of the resource.' action: type: string description: 'The action authorized by the operation (for example, GET, POST, PUT, DELETE).' organizationId: type: string description: 'The unique identifier of the organization.' userId: type: string description: 'The unique identifier of the user.' dateTime: type: string description: 'A date and time value in ISO 8601 format.' object: type: object description: 'The object affected by the operation.' properties: apiId: type: integer description: 'The unique identifier of the API.' apiName: type: string description: 'The display name of the API.' description: type: string description: 'A human-readable description of the resource.' id: type: integer description: 'The unique identifier of the resource.' name: type: string description: 'The display name of the resource.' required: - apiId - apiName - description - id - name required: - type - action - organizationId - userId - dateTime - object x-amf-mediaType: application/json description: Request payload for create notifications. responses: '200': description: Success x-amf-mediaType: text/plain content: text/plain: example: OK schema: type: string description: 'Response payload for createNotifications.' '400': description: Bad request; invalid notification format '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create a notification operationId: createNotifications /oauth2: description: oauth 2 routes /oauth2/authorize: description: OAuth2 authorization route for non-federated users get: description: OAuth2 authorization route to have the user authorize an application defined in our system parameters: - name: redirect_uri description: Redirect uri for the application required: true in: query schema: type: string - name: response_type description: Describes the type of object that the application wishes to receive upon success required: true in: query schema: type: string enum: - code - token - name: client_id description: The application's client_id that identifies the application required: true in: query schema: type: string - name: state description: A parameter with a string that will be supplied in a redirect back to the application upon success required: true in: query schema: type: string responses: '302': description: Success; redirects the user to the page to authentication & authorize the application if not logged in, or to the original application if logged in '400': description: Bad request; an invalid redirect_uri, response_type or client_id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Start OAuth2 authorization operationId: listOauth2Authorize /oauth2/authorize/{domain}: description: OAuth2 authorization route for federated or non-federated users get: description: OAuth2 authorization route that will route federated users to their authentication system and non-federated users to ours x-optionalSecurity: true parameters: - name: redirect_uri description: Redirect uri for the application required: true in: query schema: type: string - name: response_type description: Describes the type of object that the application wishes to receive upon success required: true in: query schema: type: string enum: - code - token - name: client_id description: The application's client_id that identifies the application required: true in: query schema: type: string - name: state description: A parameter with a string that will be supplied in a redirect back to the application upon success required: true in: query schema: type: string - name: domain description: Domain name to identify the organization to identify what identity management system needs to authentication the user. required: true in: path schema: type: string responses: '302': description: Success; redirects the user to the page to authentication & authorize the application if not logged in, or to the original application if logged in '400': description: Bad request; an invalid redirect_uri, response_type or client_id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - {} summary: Start OAuth2 authorization for domain operationId: listOauth2AuthorizeByDomain /oauth2/authorize/{domain}/providers: parameters: - name: domain description: Domain name to identify the organization to identify what identity management system needs to authentication the user. required: true in: path schema: type: string /oauth2/authorize/{domain}/providers/{providerId}: description: OAuth2 authorization route for federated users get: description: OAuth2 authorization route that will route federated users to their authentication system x-optionalSecurity: true parameters: - name: redirect_uri description: Redirect uri for the application required: true in: query schema: type: string - name: response_type description: Describes the type of object that the application wishes to receive upon success required: true in: query schema: type: string enum: - code - token - name: client_id description: The application's client_id that identifies the application required: true in: query schema: type: string - name: state description: A parameter with a string that will be supplied in a redirect back to the application upon success required: true in: query schema: type: string - name: domain description: Domain name to identify the organization to identify what identity management system needs to authentication the user. required: true in: path schema: type: string - name: providerId description: The identity provider configuration id used to identify the identity management system needed to authenticate the user. required: true in: path schema: type: string responses: '302': description: Success; redirects the user to the page to authentication & authorize the application if not logged in, or to the original application if logged in '400': description: Bad request; an invalid redirect_uri, response_type or client_id security: - {} summary: Authorize via identity provider operationId: getOauth2AuthorizeProviders /oauth2/decision: {} /oauth2/decision/{domain}: post: description: Confirms whether a user grants consent to add his user to an external organization parameters: - name: domain description: Domain name to identify the organization to identify what identity management system needs to authentication the user. required: true in: path schema: type: string responses: '302': description: Redirects the user to domain authorization flow security: - bearerAuth: [] - clientAuth: [] summary: Record OAuth2 consent decision operationId: createOauth2Decision /oauth2/introspect: description: Look up caller information from an access token post: description: 'Look up caller information from an access token This implements RFC-7662: OAuth 2.0 Token Introspection ' requestBody: content: application/json: schema: type: object required: - token properties: token: type: string token_type_hint: type: string example: token: b8071e09-ece8-4edd-85f4-76a30cb732f6 token_type_hint: access_token application/x-www-form-urlencoded: schema: type: object required: - token properties: token: type: string token_type_hint: type: string example: token: b8071e09-ece8-4edd-85f4-76a30cb732f6 token_type_hint: access_token x-amf-mediaType: application/json description: Request payload for create oauth2 introspect. x-amf-requestPayloads: - mediaType: application/x-www-form-urlencoded schema: type: object required: - token properties: token: type: string token_type_hint: type: string responses: '200': description: success x-amf-mediaType: application/json content: application/json: schema: type: object example: active: true token_type: bearer user_id: 40e238d8-9f6c-495f-b000-0029f5576041 username: paul.hilfinger client_id: null iat: 1539823220995 exp: 1539857830528 '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Introspect an OAuth2 token operationId: createOauth2Introspect /oauth2/token: description: OAuth2 token resource post: description: create or retrieve an OAuth2 token requestBody: content: application/json: example: grant_type: authorization_code redirect_uri: http://localhost/callback client_id: ro_client client_secret: th3S3cr3t code: 20460a62-bbdc-469d-9330-5eec892abd05 schema: type: object description: 'Request payload for createOauth2Token.' properties: grant_type: type: string description: 'The OAuth 2.0 grant type used in the request.' redirect_uri: type: string description: 'The redirect URI the user is sent to after authorization completes.' format: uri client_id: type: string description: 'The unique identifier of the client application.' client_secret: type: string description: 'The client secret used to authenticate the application when requesting tokens.' code: type: string description: 'The OAuth 2.0 authorization code returned to the client.' required: - grant_type - redirect_uri - client_id - client_secret - code x-amf-mediaType: application/json description: Request payload for create oauth2 token. responses: '200': description: success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create or retrieve OAuth2 token operationId: createOauth2Token /organizationname/{organizationName}: get: description: Check if organization name is being used x-optionalSecurity: true parameters: - name: organizationName description: The name of the organization required: true in: path schema: type: string responses: '204': description: The organization name is already taken '404': description: The organization name is available '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - {} summary: Check organization name availability operationId: getOrganizationname /organizations: description: Organizations Resource /organizations/{organizationId}: description: A single organization get: description: "Returns the referenced organization. In platform terms, **Business\ \ Group** scope for APIs such as\nAPI Manager is identified by either **id**\ \ (this org) or any **subOrganizationIds** entry (child\nBusiness Group);\ \ downstream `organizationId` path params accept any of those GUIDs when the\n\ resource lives under that group.\n\nThe response body includes:\n- **id**\ \ — GUID of this organization.\n- **subOrganizationIds** — GUIDs of child\ \ organizations (each valid as `organizationId` where the\n resource is under\ \ that subgroup).\n- **environments** — snapshot of environments for **this**\ \ org (may be partial). For a reliable\n **`environmentId`** in API Manager,\ \ prefer **listEnvironments** (GET `/organizations/{organizationId}/environments`)\n\ \ and use **`data[].id`**.\nAlso returns entitlements, owner, domain, and\ \ related metadata.\n" parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success. Body includes organization id, subOrganizationIds, optional embedded environments, and entitlements. x-amf-mediaType: application/json content: application/json: example: name: MuleSoft Inc id: f0c9b011-980e-4928-9430-e60e3a97c043 createdAt: 2015-03-13 18:03:23.869000+00:00 updatedAt: 2015-03-13 18: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-29 00:00:53.315000+00:00 updatedAt: 2015-01-29 00:00:55.163000+00:00 lastLogin: 2015-01-29 00:00:55.163000+00:00 previousLastLogin: 2015-01-28 00: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-27 20:56:02.125000+00:00 salesforce: sf_org_id: 00DSG00000CoJa78Ab apiEndpoint: https://example.my.salesforce.com schema: type: object description: 'Response payload for getOrganizations.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' orgType: type: string description: 'The classification of the organization (for example, customer, partner, internal).' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: string description: 'Identifiers of the organizations that are direct children of this organization.' entitlements: type: object description: 'The features and capabilities the organization is entitled to use.' properties: hybrid: type: object description: 'Whether hybrid deployments are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled hybridInsight: type: boolean description: 'Whether Hybrid Insight is available to the organization.' hybridAutoDiscoverProperties: type: boolean description: 'Whether hybrid runtimes can auto-discover platform properties.' createEnvironments: type: boolean description: 'Whether the organization is allowed to create environments.' globalDeployment: type: boolean description: 'Whether the entitlement allows global deployment of MuleSoft applications.' createSubOrgs: type: boolean description: 'Whether the organization is allowed to create sub-organizations.' vCoresProduction: type: object description: 'Number of production vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresSandbox: type: object description: 'Number of sandbox vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresDesign: type: object description: 'Number of design-time vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned staticIps: type: object description: 'Number of static IPs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpcs: type: object description: 'Number of Anypoint VPCs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpns: type: object description: 'Number of VPN connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned networkConnections: type: object description: 'Number of network connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned workerLoggingOverride: type: object description: 'Whether the organization can override worker logging configuration.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled messaging: type: object description: 'Whether Anypoint MQ is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned mqMessages: type: object description: 'Number of Anypoint MQ messages included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqRequests: type: object description: 'Number of Anypoint MQ requests included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqAdvancedFeatures: type: object description: 'Whether Anypoint MQ advanced features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled objectStoreRequestUnits: type: object description: 'Number of Object Store request units included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn objectStoreKeys: type: object description: 'Number of Object Store keys included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn gateways: type: object description: 'Number of API gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned designCenter: type: object description: 'Whether Anypoint Design Center is available to the organization.' properties: mozart: type: boolean description: 'Whether MuleSoft Mozart is available to the organization.' api: type: boolean description: 'Per-API capacity included in the entitlement.' apiVisual: type: boolean description: 'Whether the visual API designer is available to the organization.' apiExample: type: boolean description: 'Whether API example projects are available to the organization.' required: - mozart - api - apiVisual - apiExample partnersProduction: type: object description: 'Whether production capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned partnersSandbox: type: object description: 'Whether sandbox capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersProduction: type: object description: 'Whether B2B Trading Partner Manager production capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersSandbox: type: object description: 'Whether B2B Trading Partner Manager sandbox capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned loadBalancer: type: object description: 'Number of dedicated load balancers available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned externalIdentity: type: boolean description: 'Whether the user belongs to an external identity provider.' autoscaling: type: boolean description: 'Whether deployment autoscaling is available to the organization.' armAlerts: type: boolean description: 'Whether Anypoint Runtime Manager alerts are available to the organization.' apis: type: object description: 'Per-API limits or counters defined for the entitlement.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiCatalog: type: object description: 'Whether the API catalog is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiMonitoring: type: object description: 'Whether API monitoring is available to the organization.' properties: schedules: type: integer description: 'Whether scheduled flows are available to the organization.' required: - schedules apiCommunityManager: type: object description: 'Whether Anypoint API Community Manager is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiExperienceHub: type: object description: 'Whether Anypoint API Experience Hub is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled monitoringCenter: type: object description: 'Whether Anypoint Monitoring Center is available to the organization.' properties: productSKU: type: integer description: 'The product SKU that identifies the entitlement.' rawStorageOverrideGB: type: integer description: 'Override for the raw storage allowance, in GB.' dataRegion: type: string description: 'The cloud region where data for this organization is stored.' productionUnits: type: integer description: 'Number of production units included in the entitlement.' preProductionUnits: type: integer description: 'Number of pre-production units included in the entitlement.' storageBase: type: integer description: 'Base storage allowance included with the entitlement, in GB.' storageAddOn: type: integer description: 'Additional storage capacity provisioned on top of the base allowance, in GB.' required: - productSKU - rawStorageOverrideGB - dataRegion - productionUnits - preProductionUnits - storageBase - storageAddOn apiQuery: type: object description: 'Whether API Query is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' productSKU: type: integer description: 'The product SKU that identifies the entitlement.' required: - enabled - productSKU apiQueryC360: type: object description: 'Whether API Query for Customer 360 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled rpa: type: object description: 'Whether MuleSoft RPA is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' active: type: boolean description: 'Whether the feature or resource is currently active.' composerVersion: type: string description: 'The version of MuleSoft Composer available to the organization.' required: - enabled - active - composerVersion idp: type: object description: 'Whether the organization can configure its own identity provider.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled AutomationCreditsDW: type: object description: 'Number of automation credits available to the organization in Data Warehouse units.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned apiGovernance: type: object description: 'Whether Anypoint API Governance is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' apisPerMonth: type: integer description: 'Number of APIs the organization is allowed to manage per month.' required: - enabled - apisPerMonth apiGovernanceDomain: type: object description: 'Whether the API Governance domain feature is available to the organization.' properties: domain: type: string description: 'The domain name associated with the organization.' required: - domain crowd: type: object description: 'Whether the Crowd developer experience is available to the organization.' properties: hideApiManagerDesigner: type: boolean description: 'Whether the legacy API Manager designer is hidden from the organization.' hideFormerApiPlatform: type: boolean description: 'Whether the former API Platform UI is hidden from the organization.' environments: type: boolean description: 'The environments configured for the organization.' required: - hideApiManagerDesigner - hideFormerApiPlatform - environments cam: type: object description: 'Whether Anypoint Connectivity Access Management (CAM) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled exchange2: type: object description: 'Whether Anypoint Exchange 2 features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' assetUsageAndEngagement: type: object description: 'Whether asset usage and engagement metrics are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - enabled - assetUsageAndEngagement crowdSelfServiceMigration: type: object description: 'Whether self-service migration to Crowd is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled kpiDashboard: type: object description: 'Whether the KPI dashboard is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled pcf: type: boolean description: 'Whether the Pivotal Cloud Foundry integration is available to the organization.' appViz: type: boolean description: 'Whether Anypoint Application Visualization is available to the organization.' workerClouds: type: object description: 'Whether MuleSoft worker clouds are available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned runtimeFabric: type: boolean description: 'Whether Anypoint Runtime Fabric is available to the organization.' serviceMesh: type: object description: 'Whether Anypoint Service Mesh is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled flexGateway: type: object description: 'Whether Anypoint Omni Gateway is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled managedGatewaySmall: type: object description: 'Number of small managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned managedGatewayLarge: type: object description: 'Number of large managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned rtfManagedGateway: type: object description: 'Number of Runtime Fabric managed gateways available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled runtimeFabricCloud: type: object description: 'Whether Anypoint Runtime Fabric (Cloud) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled composer: type: object description: 'Whether MuleSoft Composer is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' tasksPerMonth: type: integer description: 'Number of tasks the organization is allowed to run per month.' maxConnectors: type: integer description: 'Maximum number of connectors the organization is allowed to use.' unlimitedConnectors: type: boolean description: 'Whether the entitlement allows the use of an unlimited number of connectors.' isHyperAutomation: type: boolean description: 'Whether the entitlement applies to MuleSoft Hyperautomation.' required: - enabled - tasksPerMonth - maxConnectors - unlimitedConnectors - isHyperAutomation muleDxWebIde: type: object description: 'Whether the Mule DX web IDE is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxGenAI: type: object description: 'Whether Mule DX generative AI features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxEDA: type: object description: 'Whether Mule DX event-driven architecture features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled usageBasedPricing: type: object description: 'Whether usage-based pricing applies to the organization.' properties: muleRuntimeIntegration: type: object description: 'Whether Mule Runtime integration features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' flows: type: integer description: 'Flow-related limits associated with the entitlement.' messages: type: integer description: 'Per-message limits or counters defined for the entitlement.' throughput: type: integer description: 'Throughput limits defined for the entitlement.' required: - enabled - flows - messages - throughput required: - muleRuntimeIntegration usageBasedPricingLimits: type: object description: 'Limits that apply to the organization under usage-based pricing.' properties: cpu: type: object description: 'CPU resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra memory: type: object description: 'Memory resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra required: - cpu - memory highAvailability: type: object description: 'Whether the entitlement allows high-availability deployments.' properties: clustering: type: boolean description: 'Whether the entitlement allows clustered deployments.' required: - clustering cloudhub1: type: object description: 'Whether CloudHub 1.0 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled telemetryExporter: type: object description: 'Whether the telemetry exporter is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled anypointSecurityEdgePolicies: type: object description: 'Whether Anypoint Security edge policies are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled anypointSecurityTokenization: type: object description: 'Whether Anypoint Security tokenization is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiManager: type: object description: 'Whether Anypoint API Manager is available to the organization.' properties: governance: type: object description: 'Whether governance features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled usageBasedPricing: type: object description: 'Whether usage-based pricing applies to the organization.' properties: api: type: object description: 'Per-API capacity included in the entitlement.' properties: production: type: object description: 'Whether the resource is available in production.' properties: amount: type: integer description: 'A numeric quantity associated with the resource.' required: - amount sandbox: type: object description: 'Whether the resource is available in sandbox environments.' properties: amount: type: integer description: 'A numeric quantity associated with the resource.' required: - amount required: - production - sandbox required: - api nonSplitPolicyModelDeprecated: type: boolean description: 'Whether the non-split policy model has been deprecated for the organization.' required: - governance - usageBasedPricing - nonSplitPolicyModelDeprecated required: - hybrid - hybridInsight - hybridAutoDiscoverProperties - createEnvironments - globalDeployment - createSubOrgs - vCoresProduction - vCoresSandbox - vCoresDesign - staticIps - vpcs - vpns - networkConnections - workerLoggingOverride - messaging - mqMessages - mqRequests - mqAdvancedFeatures - objectStoreRequestUnits - objectStoreKeys - gateways - designCenter - partnersProduction - partnersSandbox - tradingPartnersProduction - tradingPartnersSandbox - loadBalancer - externalIdentity - autoscaling - armAlerts - apis - apiCatalog - apiMonitoring - apiCommunityManager - apiExperienceHub - monitoringCenter - apiQuery - apiQueryC360 - rpa - idp - AutomationCreditsDW - apiGovernance - apiGovernanceDomain - crowd - cam - exchange2 - crowdSelfServiceMigration - kpiDashboard - pcf - appViz - workerClouds - runtimeFabric - serviceMesh - flexGateway - managedGatewaySmall - managedGatewayLarge - rtfManagedGateway - runtimeFabricCloud - composer - muleDxWebIde - muleDxGenAI - muleDxEDA - usageBasedPricing - usageBasedPricingLimits - highAvailability - cloudhub1 - telemetryExporter - anypointSecurityEdgePolicies - anypointSecurityTokenization - apiManager environments: type: array description: 'The environments configured for the organization.' items: type: object description: 'The environments configured for the organization.' properties: id: type: string description: 'The unique identifier of the resource.' organizationId: type: string description: 'The unique identifier of the organization.' name: type: string description: 'The display name of the resource.' isProduction: type: boolean description: 'Whether the environment is a production environment.' clientId: type: string description: 'The unique identifier of the client application.' required: - id - organizationId - name - isProduction - clientId tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' sessionTimeout: type: integer description: 'Length of an authenticated session before re-authentication is required, in milliseconds.' properties: type: object description: 'Additional properties associated with the resource.' properties: defaultAccessManagementUi: type: string description: 'The Access Management UI variant the organization defaults to.' required: - defaultAccessManagementUi owner: type: object description: 'The user or entity that owns the resource.' properties: id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' previousLastLogin: type: string description: 'The date and time of the user''s previous successful login, in ISO 8601 format.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email phoneNumber: type: string description: 'The user''s phone number.' username: type: string description: 'The username used to authenticate the user.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' deleted: type: boolean description: 'Whether the resource has been marked as deleted.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' type: type: string description: 'The type of the resource.' organizationId: type: string description: 'The unique identifier of the organization.' required: - id - createdAt - updatedAt - lastLogin - previousLastLogin - firstName - lastName - email - phoneNumber - username - enabled - deleted - idprovider_id - type - organizationId subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration salesforce: type: object description: 'Configuration of the Salesforce integration for the organization.' properties: sf_org_id: type: string description: 'The Salesforce organization identifier associated with this organization.' apiEndpoint: type: string description: 'Endpoint URL of the integrated service.' format: uri required: - sf_org_id - apiEndpoint required: - name - id - createdAt - updatedAt - ownerId - clientId - domain - idprovider_id - isFederated - orgType - parentOrganizationIds - subOrganizationIds - entitlements - environments - tenantOrganizationIds - isRoot - isMaster - sessionTimeout - properties - owner - subscription - salesforce '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get an organization operationId: getOrganizations put: description: Updates the referenced organization parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: content: application/json: example: 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 schema: type: object description: 'Request payload for updateOrganizations.' properties: name: type: string description: 'The display name of the resource.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' properties: type: object description: 'Additional properties associated with the resource.' properties: identity_management: type: object description: 'Configuration of the identity management integration for the organization.' properties: saml: type: object description: 'Configuration for the SAML identity provider.' properties: name: type: string description: 'The display name of the resource.' required: - name required: - saml defaultAccessManagementUi: type: string description: 'The Access Management UI variant the organization defaults to.' required: - identity_management - defaultAccessManagementUi sessionTimeout: type: integer description: 'Length of an authenticated session before re-authentication is required, in milliseconds.' entitlements: type: object description: 'The features and capabilities the organization is entitled to use.' properties: hybridInsight: type: boolean description: 'Whether Hybrid Insight is available to the organization.' hybridAutoDiscoverProperties: type: boolean description: 'Whether hybrid runtimes can auto-discover platform properties.' createEnvironments: type: boolean description: 'Whether the organization is allowed to create environments.' globalDeployment: type: boolean description: 'Whether the entitlement allows global deployment of MuleSoft applications.' createSubOrgs: type: boolean description: 'Whether the organization is allowed to create sub-organizations.' vCoresProduction: type: object description: 'Number of production vCores included in the entitlement.' properties: assigned: type: number description: 'Whether the role or team has been assigned to the user or client.' required: - assigned vCoresSandbox: type: object description: 'Number of sandbox vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned staticIps: type: object description: 'Number of static IPs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned vpcs: type: object description: 'Number of Anypoint VPCs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpns: type: object description: 'Number of VPN connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned networkConnections: type: object description: 'Number of network connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned workerLoggingOverride: type: object description: 'Whether the organization can override worker logging configuration.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled partnersProduction: type: object description: 'Whether production capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned partnersSandbox: type: object description: 'Whether sandbox capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersProduction: type: object description: 'Whether B2B Trading Partner Manager production capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersSandbox: type: object description: 'Whether B2B Trading Partner Manager sandbox capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned designCenter: type: object description: 'Whether Anypoint Design Center is available to the organization.' properties: mozart: type: boolean description: 'Whether MuleSoft Mozart is available to the organization.' api: type: boolean description: 'Per-API capacity included in the entitlement.' apiVisual: type: boolean description: 'Whether the visual API designer is available to the organization.' apiExample: type: boolean description: 'Whether API example projects are available to the organization.' required: - mozart - api - apiVisual - apiExample apiMonitoring: type: object description: 'Whether API monitoring is available to the organization.' properties: schedules: type: integer description: 'Whether scheduled flows are available to the organization.' required: - schedules apiCatalog: type: object description: 'Whether the API catalog is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiCommunityManager: type: object description: 'Whether Anypoint API Community Manager is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiExperienceHub: type: object description: 'Whether Anypoint API Experience Hub is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled monitoringCenter: type: object description: 'Whether Anypoint Monitoring Center is available to the organization.' properties: productSKU: type: integer description: 'The product SKU that identifies the entitlement.' rawStorageOverrideGB: type: integer description: 'Override for the raw storage allowance, in GB.' dataRegion: type: string description: 'The cloud region where data for this organization is stored.' productionUnits: type: integer description: 'Number of production units included in the entitlement.' preProductionUnits: type: integer description: 'Number of pre-production units included in the entitlement.' storageBase: type: integer description: 'Base storage allowance included with the entitlement, in GB.' storageAddOn: type: integer description: 'Additional storage capacity provisioned on top of the base allowance, in GB.' required: - productSKU - rawStorageOverrideGB - dataRegion - productionUnits - preProductionUnits - storageBase - storageAddOn apiQuery: type: object description: 'Whether API Query is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' productSKU: type: integer description: 'The product SKU that identifies the entitlement.' required: - enabled - productSKU apiQueryC360: type: object description: 'Whether API Query for Customer 360 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled rpa: type: object description: 'Whether MuleSoft RPA is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' active: type: boolean description: 'Whether the feature or resource is currently active.' composerVersion: type: string description: 'The version of MuleSoft Composer available to the organization.' required: - enabled - active - composerVersion idp: type: object description: 'Whether the organization can configure its own identity provider.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled AutomationCreditsDW: type: object description: 'Number of automation credits available to the organization in Data Warehouse units.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned apiGovernance: type: object description: 'Whether Anypoint API Governance is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' apisPerMonth: type: integer description: 'Number of APIs the organization is allowed to manage per month.' required: - enabled - apisPerMonth apiGovernanceDomain: type: object description: 'Whether the API Governance domain feature is available to the organization.' properties: domain: type: string description: 'The domain name associated with the organization.' required: - domain workerClouds: type: object description: 'Whether MuleSoft worker clouds are available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned runtimeFabric: type: boolean description: 'Whether Anypoint Runtime Fabric is available to the organization.' serviceMesh: type: object description: 'Whether Anypoint Service Mesh is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled flexGateway: type: object description: 'Whether Anypoint Omni Gateway is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled managedGatewaySmall: type: object description: 'Number of small managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned managedGatewayLarge: type: object description: 'Number of large managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned rtfManagedGateway: type: object description: 'Number of Runtime Fabric managed gateways available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled runtimeFabricCloud: type: object description: 'Whether Anypoint Runtime Fabric (Cloud) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled composer: type: object description: 'Whether MuleSoft Composer is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' tasksPerMonth: type: integer description: 'Number of tasks the organization is allowed to run per month.' maxConnectors: type: integer description: 'Maximum number of connectors the organization is allowed to use.' unlimitedConnectors: type: boolean description: 'Whether the entitlement allows the use of an unlimited number of connectors.' isHyperAutomation: type: boolean description: 'Whether the entitlement applies to MuleSoft Hyperautomation.' required: - enabled - tasksPerMonth - maxConnectors - unlimitedConnectors - isHyperAutomation muleDxWebIde: type: object description: 'Whether the Mule DX web IDE is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxGenAI: type: object description: 'Whether Mule DX generative AI features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxEDA: type: object description: 'Whether Mule DX event-driven architecture features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled usageBasedPricing: type: object description: 'Whether usage-based pricing applies to the organization.' properties: muleRuntimeIntegration: type: object description: 'Whether Mule Runtime integration features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' flows: type: integer description: 'Flow-related limits associated with the entitlement.' messages: type: integer description: 'Per-message limits or counters defined for the entitlement.' throughput: type: integer description: 'Throughput limits defined for the entitlement.' required: - enabled - flows - messages - throughput required: - muleRuntimeIntegration usageBasedPricingLimits: type: object description: 'Limits that apply to the organization under usage-based pricing.' properties: cpu: type: object description: 'CPU resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra memory: type: object description: 'Memory resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra required: - cpu - memory highAvailability: type: object description: 'Whether the entitlement allows high-availability deployments.' properties: clustering: type: boolean description: 'Whether the entitlement allows clustered deployments.' required: - clustering cloudhub1: type: object description: 'Whether CloudHub 1.0 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - hybridInsight - hybridAutoDiscoverProperties - createEnvironments - globalDeployment - createSubOrgs - vCoresProduction - vCoresSandbox - staticIps - vpcs - vpns - networkConnections - workerLoggingOverride - partnersProduction - partnersSandbox - tradingPartnersProduction - tradingPartnersSandbox - designCenter - apiMonitoring - apiCatalog - apiCommunityManager - apiExperienceHub - monitoringCenter - apiQuery - apiQueryC360 - rpa - idp - AutomationCreditsDW - apiGovernance - apiGovernanceDomain - workerClouds - runtimeFabric - serviceMesh - flexGateway - managedGatewaySmall - managedGatewayLarge - rtfManagedGateway - runtimeFabricCloud - composer - muleDxWebIde - muleDxGenAI - muleDxEDA - usageBasedPricing - usageBasedPricingLimits - highAvailability - cloudhub1 required: - name - ownerId - idprovider_id - properties - sessionTimeout - entitlements x-amf-mediaType: application/json description: Request payload for update organizations. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: name: MuleSoft Inc id: f0c9b011-980e-4928-9430-e60e3a97c043 createdAt: 2015-03-13 18:03:23.869000+00:00 updatedAt: 2015-03-13 18: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-27 20:56:02.125000+00:00 schema: type: object description: 'Response payload for updateOrganizations.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: string description: 'Identifiers of the organizations that are direct children of this organization.' entitlements: type: object description: 'The features and capabilities the organization is entitled to use.' properties: hybrid: type: object description: 'Whether hybrid deployments are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled hybridInsight: type: boolean description: 'Whether Hybrid Insight is available to the organization.' hybridAutoDiscoverProperties: type: boolean description: 'Whether hybrid runtimes can auto-discover platform properties.' createEnvironments: type: boolean description: 'Whether the organization is allowed to create environments.' globalDeployment: type: boolean description: 'Whether the entitlement allows global deployment of MuleSoft applications.' createSubOrgs: type: boolean description: 'Whether the organization is allowed to create sub-organizations.' vCoresProduction: type: object description: 'Number of production vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresSandbox: type: object description: 'Number of sandbox vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresDesign: type: object description: 'Number of design-time vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned staticIps: type: object description: 'Number of static IPs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpcs: type: object description: 'Number of Anypoint VPCs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpns: type: object description: 'Number of VPN connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned networkConnections: type: object description: 'Number of network connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned workerLoggingOverride: type: object description: 'Whether the organization can override worker logging configuration.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled messaging: type: object description: 'Whether Anypoint MQ is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned mqMessages: type: object description: 'Number of Anypoint MQ messages included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqRequests: type: object description: 'Number of Anypoint MQ requests included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqAdvancedFeatures: type: object description: 'Whether Anypoint MQ advanced features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled objectStoreRequestUnits: type: object description: 'Number of Object Store request units included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn objectStoreKeys: type: object description: 'Number of Object Store keys included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn gateways: type: object description: 'Number of API gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned designCenter: type: object description: 'Whether Anypoint Design Center is available to the organization.' properties: mozart: type: boolean description: 'Whether MuleSoft Mozart is available to the organization.' api: type: boolean description: 'Per-API capacity included in the entitlement.' apiVisual: type: boolean description: 'Whether the visual API designer is available to the organization.' apiExample: type: boolean description: 'Whether API example projects are available to the organization.' required: - mozart - api - apiVisual - apiExample partnersProduction: type: object description: 'Whether production capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned partnersSandbox: type: object description: 'Whether sandbox capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersProduction: type: object description: 'Whether B2B Trading Partner Manager production capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersSandbox: type: object description: 'Whether B2B Trading Partner Manager sandbox capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned loadBalancer: type: object description: 'Number of dedicated load balancers available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned externalIdentity: type: boolean description: 'Whether the user belongs to an external identity provider.' autoscaling: type: boolean description: 'Whether deployment autoscaling is available to the organization.' armAlerts: type: boolean description: 'Whether Anypoint Runtime Manager alerts are available to the organization.' apis: type: object description: 'Per-API limits or counters defined for the entitlement.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiCatalog: type: object description: 'Whether the API catalog is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiMonitoring: type: object description: 'Whether API monitoring is available to the organization.' properties: schedules: type: integer description: 'Whether scheduled flows are available to the organization.' required: - schedules apiCommunityManager: type: object description: 'Whether Anypoint API Community Manager is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiExperienceHub: type: object description: 'Whether Anypoint API Experience Hub is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled monitoringCenter: type: object description: 'Whether Anypoint Monitoring Center is available to the organization.' properties: productSKU: type: integer description: 'The product SKU that identifies the entitlement.' rawStorageOverrideGB: type: integer description: 'Override for the raw storage allowance, in GB.' dataRegion: type: string description: 'The cloud region where data for this organization is stored.' productionUnits: type: integer description: 'Number of production units included in the entitlement.' preProductionUnits: type: integer description: 'Number of pre-production units included in the entitlement.' storageBase: type: integer description: 'Base storage allowance included with the entitlement, in GB.' storageAddOn: type: integer description: 'Additional storage capacity provisioned on top of the base allowance, in GB.' required: - productSKU - rawStorageOverrideGB - dataRegion - productionUnits - preProductionUnits - storageBase - storageAddOn apiQuery: type: object description: 'Whether API Query is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' productSKU: type: integer description: 'The product SKU that identifies the entitlement.' required: - enabled - productSKU apiQueryC360: type: object description: 'Whether API Query for Customer 360 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled rpa: type: object description: 'Whether MuleSoft RPA is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' active: type: boolean description: 'Whether the feature or resource is currently active.' composerVersion: type: string description: 'The version of MuleSoft Composer available to the organization.' required: - enabled - active - composerVersion idp: type: object description: 'Whether the organization can configure its own identity provider.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled AutomationCreditsDW: type: object description: 'Number of automation credits available to the organization in Data Warehouse units.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned apiGovernance: type: object description: 'Whether Anypoint API Governance is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' apisPerMonth: type: integer description: 'Number of APIs the organization is allowed to manage per month.' required: - enabled - apisPerMonth apiGovernanceDomain: type: object description: 'Whether the API Governance domain feature is available to the organization.' properties: domain: type: string description: 'The domain name associated with the organization.' required: - domain crowd: type: object description: 'Whether the Crowd developer experience is available to the organization.' properties: hideApiManagerDesigner: type: boolean description: 'Whether the legacy API Manager designer is hidden from the organization.' hideFormerApiPlatform: type: boolean description: 'Whether the former API Platform UI is hidden from the organization.' environments: type: boolean description: 'The environments configured for the organization.' required: - hideApiManagerDesigner - hideFormerApiPlatform - environments cam: type: object description: 'Whether Anypoint Connectivity Access Management (CAM) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled exchange2: type: object description: 'Whether Anypoint Exchange 2 features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' assetUsageAndEngagement: type: object description: 'Whether asset usage and engagement metrics are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - enabled - assetUsageAndEngagement crowdSelfServiceMigration: type: object description: 'Whether self-service migration to Crowd is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled kpiDashboard: type: object description: 'Whether the KPI dashboard is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled pcf: type: boolean description: 'Whether the Pivotal Cloud Foundry integration is available to the organization.' appViz: type: boolean description: 'Whether Anypoint Application Visualization is available to the organization.' workerClouds: type: object description: 'Whether MuleSoft worker clouds are available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned runtimeFabric: type: boolean description: 'Whether Anypoint Runtime Fabric is available to the organization.' runtimeFabricCloud: type: object description: 'Whether Anypoint Runtime Fabric (Cloud) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled serviceMesh: type: object description: 'Whether Anypoint Service Mesh is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled flexGateway: type: object description: 'Whether Anypoint Omni Gateway is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled managedGatewaySmall: type: object description: 'Number of small managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned managedGatewayLarge: type: object description: 'Number of large managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned rtfManagedGateway: type: object description: 'Number of Runtime Fabric managed gateways available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled composer: type: object description: 'Whether MuleSoft Composer is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' tasksPerMonth: type: integer description: 'Number of tasks the organization is allowed to run per month.' maxConnectors: type: integer description: 'Maximum number of connectors the organization is allowed to use.' unlimitedConnectors: type: boolean description: 'Whether the entitlement allows the use of an unlimited number of connectors.' isHyperAutomation: type: boolean description: 'Whether the entitlement applies to MuleSoft Hyperautomation.' required: - enabled - tasksPerMonth - maxConnectors - unlimitedConnectors - isHyperAutomation muleDxWebIde: type: object description: 'Whether the Mule DX web IDE is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxGenAI: type: object description: 'Whether Mule DX generative AI features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxEDA: type: object description: 'Whether Mule DX event-driven architecture features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled cloudhub1: type: object description: 'Whether CloudHub 1.0 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled telemetryExporter: type: object description: 'Whether the telemetry exporter is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - hybrid - hybridInsight - hybridAutoDiscoverProperties - createEnvironments - globalDeployment - createSubOrgs - vCoresProduction - vCoresSandbox - vCoresDesign - staticIps - vpcs - vpns - networkConnections - workerLoggingOverride - messaging - mqMessages - mqRequests - mqAdvancedFeatures - objectStoreRequestUnits - objectStoreKeys - gateways - designCenter - partnersProduction - partnersSandbox - tradingPartnersProduction - tradingPartnersSandbox - loadBalancer - externalIdentity - autoscaling - armAlerts - apis - apiCatalog - apiMonitoring - apiCommunityManager - apiExperienceHub - monitoringCenter - apiQuery - apiQueryC360 - rpa - idp - AutomationCreditsDW - apiGovernance - apiGovernanceDomain - crowd - cam - exchange2 - crowdSelfServiceMigration - kpiDashboard - pcf - appViz - workerClouds - runtimeFabric - runtimeFabricCloud - serviceMesh - flexGateway - managedGatewaySmall - managedGatewayLarge - rtfManagedGateway - composer - muleDxWebIde - muleDxGenAI - muleDxEDA - cloudhub1 - telemetryExporter tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' sessionTimeout: type: integer description: 'Length of an authenticated session before re-authentication is required, in milliseconds.' properties: type: object description: 'Additional properties associated with the resource.' properties: defaultAccessManagementUi: type: string description: 'The Access Management UI variant the organization defaults to.' required: - defaultAccessManagementUi subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration required: - name - id - createdAt - updatedAt - ownerId - clientId - domain - idprovider_id - isFederated - parentOrganizationIds - subOrganizationIds - entitlements - tenantOrganizationIds - isRoot - isMaster - sessionTimeout - properties - subscription '400': description: Invalid or incomplete body '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update an organization operationId: updateOrganizations delete: description: Deletes the referenced organization parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success '400': description: Invalid or incomplete body '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete an organization operationId: deleteOrganizations /organizations/{organizationId}/clientProviders: get: description: Returns list of client management providers for the root organization with a subset of values (providerId, organizationId, name, type (name, description, version)) parameters: - name: provider_id description: One or more ids of the provider(s) to return. in: query style: form explode: false schema: type: array items: type: string - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: ascending description: Whether to sort ascending or descending required: true in: query schema: type: boolean default: true - name: cp_type description: One or more types of provider(s) to return. in: query style: form explode: false schema: type: array items: type: string - name: sort description: The field to sort on. required: false in: query schema: type: string enum: - provider_id - name default: provider_id - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - name: search description: A search string to use for case-insensitive partial matches on name required: false in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/ExternalClientProvidersFind' total: type: number example: 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 '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List client management providers operationId: listClientProviders post: description: Adds a new client management provider for the organization. This can be called only on Root Organizations parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/ExternalClientProvider' responses: '201': description: Success '400': description: Invalid data in body '401': description: Unauthorized '404': description: Organization does not exist '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create a client management provider operationId: createClientProviders /organizations/{organizationId}/clientProviders/{clientProviderId}: get: description: 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 parameters: - name: includeSecrets description: flag to include the secrets as part of the response or not required: true in: query schema: type: boolean default: false - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_clientProviderId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/ExternalClientProvider' '401': description: Unauthorized '404': description: Client Provider ID does not exist in the Organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get a client management provider operationId: getClientProviders put: description: Replaces the associated client management provider config parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_clientProviderId_Path' requestBody: $ref: '#/components/requestBodies/ExternalClientProvider' responses: '200': description: Success '400': description: Invalid data in body '401': description: Unauthorized '404': description: Client Provider ID does not exist in the Organization '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Replace a client management provider operationId: updateClientProviders patch: description: Updates the associated client management provider config parameters: - name: recreateTokenValidationClient description: flag to indicate whether to recreate token validation client on update or not required: true in: query schema: type: boolean default: false - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_clientProviderId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExternalClientProviderOptional' x-amf-mediaType: application/json description: Request payload for update client providers2. responses: '200': description: Success '400': description: Invalid data in body '401': description: Unauthorized '404': description: Client Provider ID does not exist in the Organization '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Patch a client management provider operationId: updateOrganizationClientProvider delete: description: Deletes the associated client management provider parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_clientProviderId_Path' responses: '204': description: Success '401': description: Unauthorized '404': description: Client Provider ID does not exist in the Organization '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete a client management provider operationId: deleteClientProviders /organizations/{organizationId}/clientProviders/{clientProviderId}/grantTypes: get: description: Returns the associated client management provider type and grant types it suppports. parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_clientProviderId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/clientProvidersTypeAndGrantTypes' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List provider grant types operationId: listClientProvidersGrantTypes /organizations/{organizationId}/clientProviders/{clientProviderId}/clients: get: description: Returns the clients created using this specific Client Management Provider parameters: - name: client_id description: One or more ids of the client(s) to return. in: query style: form explode: false schema: type: array items: type: string - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: ascending description: Whether to sort ascending or descending required: true in: query schema: type: boolean default: true - name: sort description: The field to sort on. required: false in: query schema: type: string enum: - client_id - client_name default: client_id - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - name: search description: A search string to use for case-insensitive partial matches on client_name required: false in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_clientProviderId_Path' responses: '200': description: Sucess x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for listClientProvidersClients.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: client_id: type: string description: 'The unique identifier of the client application.' client_name: type: string description: 'The display name of the client application.' client_secret: type: string description: 'The client secret used to authenticate the application when requesting tokens.' grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri org_id: type: string description: 'The unique identifier of the organization.' client_management_provider_id: type: string description: 'The unique identifier of the client management identity provider associated with the resource.' required: - client_id - client_name - client_secret - grant_types - redirect_uris - org_id - client_management_provider_id total: type: integer description: 'The total number of items available across all pages.' required: - data - total '401': description: Unauthorized '404': description: Organization or Client Management Provider does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List provider clients operationId: listClientProvidersClients post: description: Adds a new client using the Client Management Provider parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_clientProviderId_Path' requestBody: $ref: '#/components/requestBodies/ClientProviderClient' responses: '201': description: Success '400': description: Invalid data in body '401': description: Unauthorized '404': description: Organization or Client Management Provider does not exist '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create a provider client operationId: createClientProvidersClients /organizations/{organizationId}/clientProviders/{clientProviderId}/clients/{clientId}: get: description: Returns the associated clients info parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_clientProviderId_Path' - $ref: '#/components/parameters/XOrigin_clientProviderClientId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for getClientProvidersClients.' properties: client_id: type: string description: 'The unique identifier of the client application.' client_name: type: string description: 'The display name of the client application.' client_secret: type: string description: 'The client secret used to authenticate the application when requesting tokens.' grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri org_id: type: string description: 'The unique identifier of the organization.' client_management_provider_id: type: string description: 'The unique identifier of the client management identity provider associated with the resource.' required: - client_id - client_name - client_secret - grant_types - redirect_uris - org_id - client_management_provider_id '401': description: Unauthorized '404': description: ClientId does not exist in the Organization or Client Management Provider '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get a provider client operationId: getClientProvidersClients patch: description: Updates the associated client parameters: - name: force description: If true, client is going to be updated in Anypoint no matter if it's updated from the external client provider. in: query schema: type: string enum: - 'true' - 'false' - name: resetSecret description: Asks service to reset secret as part of this operation in: query schema: type: boolean default: false - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_clientProviderId_Path' - $ref: '#/components/parameters/XOrigin_clientProviderClientId_Path' requestBody: $ref: '#/components/requestBodies/ClientProviderClient' responses: '200': description: Success '400': description: Invalid data in body '401': description: Unauthorized '404': description: ClientId does not exist in the Organization or Client Management Provider '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update a provider client operationId: updateClientProvidersClients delete: description: Deletes the associated client parameters: - name: force description: If true, client is going to be deleted from Anypoint no matter if it's deleted from the external client provider. in: query schema: type: string enum: - 'true' - 'false' - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_clientProviderId_Path' - $ref: '#/components/parameters/XOrigin_clientProviderClientId_Path' responses: '204': description: Success '401': description: Unauthorized '404': description: ClientId does not exist in the Organization or Client Management Provider '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete a provider client operationId: deleteClientProvidersClients /organizations/{organizationId}/clients: description: Access to clients get: description: Get all clients parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for listOrganizationClients.' properties: ac_client: type: object description: 'The client used by the platform to perform authorization-code flows.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - redirect_uris - grant_types - properties - org_id rs_client: type: object description: 'The client used by the platform to perform resource-server operations.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - grant_types - properties - org_id ro_client: type: object description: 'The client used by the platform to perform resource-owner operations.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - grant_types - properties - org_id cc_client: type: object description: 'The client used by the platform to perform client-credentials flows.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - grant_types - properties - org_id im_client: type: object description: 'The client used by the platform to integrate with the identity manager.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - redirect_uris - grant_types - properties - org_id cp_client: type: object description: 'The client used by the platform to communicate with the control plane.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' org_id: type: string description: 'The unique identifier of the organization.' client_management_provider_id: type: string description: 'The unique identifier of the client management identity provider associated with the resource.' required: - client_id - name - redirect_uris - grant_types - org_id - client_management_provider_id required: - ac_client - rs_client - ro_client - cc_client - im_client - cp_client '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List organization clients operationId: listOrganizationClients post: description: Create a new client parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/Generated6' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for createOrganizationClient.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - redirect_uris - grant_types - properties - org_id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create an organization client operationId: createOrganizationClient /organizations/{organizationId}/clients/{clientId}: description: Access to a client get: description: Get a single client parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedClientId_Path' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for getOrganizationClient.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - redirect_uris - grant_types - properties - org_id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get an organization client operationId: getOrganizationClient patch: description: Patches a single client parameters: - name: resetSecret description: Asks service to reset secret as part of this operation required: true in: query schema: type: boolean - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedClientId_Path' requestBody: $ref: '#/components/requestBodies/Generated7' responses: '200': description: '' '400': description: '' '404': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update an organization client operationId: updateOrganizationClient delete: description: Deletes a single client parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedClientId_Path' responses: '200': description: '' '400': description: '' '404': description: '' '409': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete an organization client operationId: deleteOrganizationClient /organizations/{organizationId}/clients/{clientId}/roles: description: Access to a client's roles post: description: Assign a list of roles to a client parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedClientId_Path' requestBody: $ref: '#/components/requestBodies/Generated5' responses: '200': description: '' '400': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Assign roles to an org client operationId: createOrganizationClientRole delete: description: Unassign a list of roles from a client parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedClientId_Path' requestBody: $ref: '#/components/requestBodies/Generated5' responses: '200': description: '' '400': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Unassign roles from an org client operationId: deleteOrganizationClientRoles /organizations/{organizationId}/clients/{clientId}/roles/{roleId}: post: description: Assign a role to a client parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedClientId_Path' - name: roleId required: true in: path schema: type: string description: The unique identifier of the role. requestBody: $ref: '#/components/requestBodies/Generated3' responses: '200': description: '' '400': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Assign a role to an org client operationId: createOrganizationClientRoleById delete: description: 'Unassign a role from a client ' parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedClientId_Path' - name: roleId required: true in: path schema: type: string description: The unique identifier of the role. responses: '200': description: '' '400': description: '' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Unassign a role from an org client operationId: deleteOrganizationClientRole /organizations/{organizationId}/clients/search: post: description: Search clients parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/OrgClientsSearch' x-amf-mediaType: application/json description: Request payload for create clients search2. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: - 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 schema: type: array description: 'Response payload for createOrganizationClientsSearch.' items: type: object description: 'Response payload for createOrganizationClientsSearch.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - redirect_uris - grant_types - properties - org_id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Search organization clients operationId: createOrganizationClientsSearch /organizations/{organizationId}/clients/validate: post: description: Validate clients parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/OrgClientValidate' x-amf-mediaType: application/json description: Request payload for create clients validate. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for createClientsValidate.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - redirect_uris - grant_types - properties - org_id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Validate organization clients operationId: createClientsValidate /organizations/{organizationId}/connectedApplications: description: Access to connected applications get: description: Get all connected applications for the organization parameters: - name: includeUsage description: flag to indicate whether to return usage statistics required: true in: query schema: type: boolean default: false - name: hide_managed description: Hides the managed connected apps when set to true. in: query schema: type: boolean default: true - $ref: '#/components/parameters/XOrigin_organizationId_Query' - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: ascending description: Whether to sort ascending or descending required: true in: query schema: type: boolean default: true - name: sort description: The field to sort on. required: false in: query schema: type: string enum: - client_id - client_name default: client_name - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 20 default: 20 - name: search description: A search string to use for case-insensitive partial matches on all object properties required: false in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for listOrganizationConnectedApplications.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: client_id: type: string description: 'The unique identifier of the client application.' owner_org_id: type: string description: 'The unique identifier of the organization that owns the resource.' client_name: type: string description: 'The display name of the client application.' client_secret: type: string description: 'The client secret used to authenticate the application when requesting tokens.' public_keys: type: array description: 'The public keys used to verify signatures issued by the resource.' items: type: object redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' scopes: type: array description: 'The OAuth 2.0 scopes granted to the resource.' items: type: object enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' audience: type: string description: 'The audience (intended recipient) of the issued token, as defined by the OAuth 2.0 specification.' client_uri: type: 'null' description: 'URL of the homepage of the client application.' policy_uri: type: 'null' description: 'URL of the privacy policy of the client application.' tos_uri: type: 'null' description: 'URL of the terms of service of the client application.' generate_iss_claim_without_token: type: boolean description: 'Whether the issuer claim should be generated when no access token is present.' required: - client_id - owner_org_id - client_name - client_secret - public_keys - redirect_uris - grant_types - scopes - enabled - audience - client_uri - policy_uri - tos_uri - generate_iss_claim_without_token total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List org connected applications operationId: listOrganizationConnectedApplications post: description: Create a new connected application parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/ConnectedApplicationCreate' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for createOrganizationConnectedApplication.' properties: client_id: type: string description: 'The unique identifier of the client application.' owner_org_id: type: string description: 'The unique identifier of the organization that owns the resource.' client_name: type: string description: 'The display name of the client application.' client_secret: type: string description: 'The client secret used to authenticate the application when requesting tokens.' public_keys: type: array description: 'The public keys used to verify signatures issued by the resource.' items: type: object redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' scopes: type: array description: 'The OAuth 2.0 scopes granted to the resource.' items: type: object enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' audience: type: string description: 'The audience (intended recipient) of the issued token, as defined by the OAuth 2.0 specification.' generate_iss_claim_without_token: type: boolean description: 'Whether the issuer claim should be generated when no access token is present.' required: - client_id - owner_org_id - client_name - client_secret - public_keys - redirect_uris - grant_types - scopes - enabled - audience - generate_iss_claim_without_token '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create an org connected application operationId: createOrganizationConnectedApplication /organizations/{organizationId}/connectedApplications/{clientId}: description: Access to individual connected application get: description: Get a single connected application parameters: - name: includeUsage description: flag to indicate whether to return usage statistics required: true in: query schema: type: boolean default: false - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedConnectedApplicationClientId_Path' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for getOrganizationConnectedApplication.' properties: client_id: type: string description: 'The unique identifier of the client application.' owner_org_id: type: string description: 'The unique identifier of the organization that owns the resource.' client_name: type: string description: 'The display name of the client application.' client_secret: type: string description: 'The client secret used to authenticate the application when requesting tokens.' public_keys: type: array description: 'The public keys used to verify signatures issued by the resource.' items: type: object redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' scopes: type: array description: 'The OAuth 2.0 scopes granted to the resource.' items: type: object enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' audience: type: string description: 'The audience (intended recipient) of the issued token, as defined by the OAuth 2.0 specification.' generate_iss_claim_without_token: type: boolean description: 'Whether the issuer claim should be generated when no access token is present.' required: - client_id - owner_org_id - client_name - client_secret - public_keys - redirect_uris - grant_types - scopes - enabled - audience - generate_iss_claim_without_token '404': description: Connected application with that clientId could not be found '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get an org connected application operationId: getOrganizationConnectedApplication patch: description: Patches a single connected application parameters: - name: resetSecret description: Asks service to reset secret as part of this operation in: query schema: type: boolean default: false - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedConnectedApplicationClientId_Path' requestBody: $ref: '#/components/requestBodies/ConnectedApplicationUpdate' responses: '200': description: Connected Application was successfully updated x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for updateOrganizationConnectedApplication.' properties: client_id: type: string description: 'The unique identifier of the client application.' owner_org_id: type: string description: 'The unique identifier of the organization that owns the resource.' client_name: type: string description: 'The display name of the client application.' client_secret: type: string description: 'The client secret used to authenticate the application when requesting tokens.' public_keys: type: array description: 'The public keys used to verify signatures issued by the resource.' items: type: object redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' scopes: type: array description: 'The OAuth 2.0 scopes granted to the resource.' items: type: object enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' audience: type: string description: 'The audience (intended recipient) of the issued token, as defined by the OAuth 2.0 specification.' generate_iss_claim_without_token: type: boolean description: 'Whether the issuer claim should be generated when no access token is present.' required: - client_id - owner_org_id - client_name - client_secret - public_keys - redirect_uris - grant_types - scopes - enabled - audience - generate_iss_claim_without_token '404': description: Connected Application with that organizationId and clientId could not be found '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update an org connected application operationId: updateOrganizationConnectedApplication delete: description: Deletes a single connected application parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedConnectedApplicationClientId_Path' responses: '204': description: Connected application was deleted '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete an org connected application operationId: deleteOrganizationConnectedApplication /organizations/{organizationId}/connectedApplications/{clientId}/scopes: description: 'Routes for operationg upon context-aware scopes assigned directly to the client''s identity, only for use with the client_credentials grant type. Orthogonal to the set of scopes associated with user authorizations. ' get: description: Retrieves context-aware scopes assigned to the connected application parameters: - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedConnectedApplicationClientId_Path' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: data: - scope: example:scope context_params: org: 8b0b657c-91ca-420d-870a-08699094f5e4 envId: 7cc0463b-f7be-418d-8a64-84fbad13ab00 total: 1 schema: type: object description: 'Response payload for listOrganizationConnectedApplicationScopes.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: scope: type: string description: 'The OAuth 2.0 scope granted to the resource.' context_params: type: object description: 'Additional parameters that scope the operation to a specific organization or environment.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' envId: type: string description: 'The unique identifier of the environment.' required: - org - envId required: - scope - context_params total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List org connected app scopes operationId: listOrgConnectedAppScopes put: description: Replaces the entire list of context-aware scopes assigned to the connected application parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedConnectedApplicationClientId_Path' requestBody: $ref: '#/components/requestBodies/Generated8' responses: '204': description: Connected application scopes were successfully replaced '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Replace org connected app scopes operationId: replaceOrgConnectedAppScopes patch: description: 'Assigns additional context-aware scopes to the connected application. Does not unassign any existing scopes. Duplicate entries are ignored. ' parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedConnectedApplicationClientId_Path' requestBody: $ref: '#/components/requestBodies/Generated9' responses: '204': description: Connected application scopes were successfully assigned '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Add scopes to org connected app operationId: addOrgConnectedAppScopes delete: description: 'Unassigns context-aware scopes from the connected application. Scopes must exactly match in order to be removed. ' parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedConnectedApplicationClientId_Path' requestBody: $ref: '#/components/requestBodies/Generated8' responses: '204': description: Connected application scopes were successfully unassigned '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Remove scopes from org connected app operationId: removeOrgConnectedAppScopes /organizations/{organizationId}/connectedApplications/{clientId}/revoke: delete: description: Revoke all access tokens and refresh tokens issued to the connected application parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedConnectedApplicationClientId_Path' responses: '204': description: All tokens were revoked successfully '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Revoke org connected app tokens operationId: revokeOrganizationConnectedApplication /organizations/{organizationId}/connectedApplications/authorizations: description: Permissions granted to connected applications by users within the organization get: description: Returns all the authorizations that grant access to resources in the organization. parameters: - name: user_id description: Only return authorizations granted by that user required: false in: query schema: type: string - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/UserAuthorization' total: type: number example: data: - authorization_id: '456' created_at: 2018-01-26 22:39:02.312000+00:00 updated_at: 2018-01-26 22:39:02.312000+00:00 last_used: 2018-01-26 22: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 '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List connected app authorizations operationId: listConnectedApplicationsAuthorizations delete: description: Revoke all authorizations that grant rights to accessing resources in the business group. Only available on the root organization. parameters: - name: user_id description: Only delete authorizations granted by that user required: true in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '204': description: Success '405': description: The organization is a business group. Revoking must be done from a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Revoke all connected app authorizations operationId: revokeOrgConnectedAppAuths /organizations/{organizationId}/connectedApplications/authorizations/{authorizationId}: get: description: Returns a single authorization parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - name: authorizationId description: The ID of the authorization required: true in: path schema: type: string responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/UserAuthorization' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get a connected app authorization operationId: getConnectedApplicationsAuthorizations delete: description: Revokes an authorization. Only available on the root organization. parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - name: authorizationId description: The ID of the authorization required: true in: path schema: type: string responses: '204': description: Success '405': description: The organization is a business group. Revoking must be done from a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Revoke a connected app authorization operationId: revokeOrgConnectedAppAuth /organizations/{organizationId}/connectedApplications/settings: get: description: Returns the organization's Connected Application settings. For business groups, this will return the root organization's settings. parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/ConnectedApplicationSettings' '404': description: The organization does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get connected app settings operationId: listConnectedApplicationsSettings patch: description: Updates the organization's connected application settings parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectedApplicationSettingsUpdate' x-amf-mediaType: application/json description: Request payload for update connected applications settings. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/ConnectedApplicationSettings' '404': description: The organization does not exist '405': description: The organization is a business group. Settings are only editable on a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update connected app settings operationId: updateConnectedApplicationsSettings /organizations/{organizationId}/connectedApplications/allowlist: get: description: Returns the entries on the organization's Connected Application allowlist parameters: - name: client_id description: search for allowlist entries by specific client_id in: query style: form explode: false schema: type: array items: type: string - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/ConnectedApplicationSettingsAllowlistEntry' total: type: number example: data: - client_id: cba8d24f-8e6b-4615-9bb8-bc5a2c9933cd authorized_scopes: - openid - offline_access - read:organization total: 1 '404': description: The organization does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List connected app allowlist operationId: listConnectedApplicationsAllowlist put: description: Replaces the organization's Connected Application allowlist with a new one parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/ConnectedApplicationSettingsAllowlist' responses: '204': description: Success '404': description: The organization does not exist '405': description: The organization is a business group. The allowlist is only editable on a root organization. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Replace connected app allowlist operationId: updateConnectedApplicationsAllowlist patch: description: Inserts the entries into the organization's Connected Application allowlist parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/ConnectedApplicationSettingsAllowlist' responses: '204': description: Success '404': description: The organization does not exist '405': description: The organization is a business group. The allowlist is only editable on a root organization. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Add entries to connected app allowlist operationId: addOrgConnectedAppAllowlist delete: description: Deletes the entries from the organization's Connected Application allowlist parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/ConnectedApplicationSettingsAllowlist' responses: '204': description: Success '404': description: The organization does not exist '405': description: The organization is a business group. The allowlist is only editable on a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Remove entries from allowlist operationId: deleteConnectedApplicationsAllowlist /organizations/{organizationId}/connectedApplications/whitelist: get: description: Returns the entries on the organization's Connected Application allowlist parameters: - name: client_id description: search for allowlist entries by specific client_id in: query style: form explode: false schema: type: array items: type: string - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/ConnectedApplicationSettingsWhitelistEntry' total: type: number example: data: - client_id: cba8d24f-8e6b-4615-9bb8-bc5a2c9933cd authorized_scopes: - openid - offline_access - read:organization total: 1 '404': description: The organization does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List connected app whitelist operationId: listConnectedApplicationsWhitelist put: description: Replaces the organization's Connected Application allowlist with a new one parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/ConnectedApplicationSettingsWhitelist' responses: '204': description: Success '404': description: The organization does not exist '405': description: The organization is a business group. The allowlist is only editable on a root organization. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Replace connected app whitelist operationId: updateConnectedApplicationsWhitelist patch: description: Inserts the entries into the organization's Connected Application allowlist parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/ConnectedApplicationSettingsWhitelist' responses: '204': description: Success '404': description: The organization does not exist '405': description: The organization is a business group. The allowlist is only editable on a root organization. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Add entries to connected app whitelist operationId: addOrgConnectedAppWhitelist delete: description: Deletes the entries from the organization's Connected Application allowlist parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/ConnectedApplicationSettingsWhitelist' responses: '204': description: Success '404': description: The organization does not exist '405': description: The organization is a business group. The allowlist is only editable on a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Remove entries from whitelist operationId: deleteConnectedApplicationsWhitelist /organizations/{organizationId}/entitlements: description: Entitlements for a given organization get: description: Returns the entitlements for the organization parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List organization entitlements operationId: listEntitlements /organizations/{organizationId}/entitlements/{entitlementName}: description: Entitlement by name get: description: Get an entitlement by name parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - name: entitlementName description: The name of an entitlement required: true in: path schema: type: string responses: '200': description: Success '404': description: Entitlement with that name does not exists '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get an entitlement operationId: getEntitlements put: description: 'Update an entitlement. Note: Connected apps cannot perform this action and is reserved only for org admins. ' parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - name: entitlementName description: The name of an entitlement required: true in: path schema: type: string requestBody: content: application/json: example: value: values: '{"enabled":false}' schema: type: object description: 'Request payload for updateEntitlements.' properties: value: type: object description: 'A single value returned by the request.' properties: values: type: string description: 'The list of values returned by the request.' required: - values required: - value x-amf-mediaType: application/json description: Request payload for update entitlements. responses: '200': description: Success '404': description: Entitlement with that name does not exists '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update an entitlement operationId: updateEntitlements /organizations/{organizationId}/environments: description: Environments from an organization get: description: Returns all matching environments parameters: - name: name description: Case sensitive match on the environment name required: false in: query schema: type: string - name: isProduction description: Whether returns only production or non-production environments required: false in: query schema: type: boolean - name: expandAll description: Returns all environments within the rootOrg that caller has access to. If this is true, orgId has to be a valid rootOrgId. required: false in: query schema: type: string - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: type description: The type of environment - production, sandbox, or/or design required: false in: query schema: type: string - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - name: search description: A search string to use for case-insensitive partial matches on environment names required: false in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Returns environments x-amf-mediaType: application/json content: application/json: example: data: - id: f0c9b011-980e-4928-9430-e60e3a97c043 organizationId: 70b3f7cb-614c-4276-b0cd-4f73db11602c name: Development isProduction: true type: production clientId: abdf31490ba44484a1de789baf685e37 total: 1 schema: type: object description: 'Response payload for listEnvironments.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: id: type: string description: 'The unique identifier of the resource.' organizationId: type: string description: 'The unique identifier of the organization.' name: type: string description: 'The display name of the resource.' isProduction: type: boolean description: 'Whether the environment is a production environment.' type: type: string description: 'The type of the resource.' clientId: type: string description: 'The unique identifier of the client application.' required: - id - organizationId - name - isProduction - type - clientId total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List environments operationId: listEnvironments post: description: Creates an environment parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: content: application/json: example: name: Development isProduction: false type: sandbox schema: type: object description: 'Request payload for createEnvironments.' properties: name: type: string description: 'The display name of the resource.' isProduction: type: boolean description: 'Whether the environment is a production environment.' type: type: string description: 'The type of the resource.' required: - name - isProduction - type x-amf-mediaType: application/json description: Request payload for create environments. responses: '201': description: Environment created. Returns the newly created environment x-amf-mediaType: application/json content: application/json: example: id: f0c9b011-980e-4928-9430-e60e3a97c043 organizationId: 70b3f7cb-614c-4276-b0cd-4f73db11602c name: Development isProduction: false type: sandbox clientId: abdf31490ba44484a1de789baf685e37 schema: type: object description: 'Response payload for createEnvironments.' properties: id: type: string description: 'The unique identifier of the resource.' organizationId: type: string description: 'The unique identifier of the organization.' name: type: string description: 'The display name of the resource.' isProduction: type: boolean description: 'Whether the environment is a production environment.' type: type: string description: 'The type of the resource.' clientId: type: string description: 'The unique identifier of the client application.' required: - id - organizationId - name - isProduction - type - clientId '400': description: 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). '403': description: The organization is not entitled to be able to create new environments. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create an environment operationId: createEnvironments /organizations/{organizationId}/environments/{environmentId}: description: Environment by id get: description: Retrieves an environment by id parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_environmentId_Path' responses: '200': description: Returns the environment x-amf-mediaType: application/json content: application/json: example: id: f0c9b011-980e-4928-9430-e60e3a97c043 organizationId: 70b3f7cb-614c-4276-b0cd-4f73db11602c name: Development isProduction: false type: sandbox clientId: abdf31490ba44484a1de789baf685e37 schema: type: object description: 'Response payload for getOrganizationEnvironment.' properties: id: type: string description: 'The unique identifier of the resource.' organizationId: type: string description: 'The unique identifier of the organization.' name: type: string description: 'The display name of the resource.' isProduction: type: boolean description: 'Whether the environment is a production environment.' type: type: string description: 'The type of the resource.' clientId: type: string description: 'The unique identifier of the client application.' required: - id - organizationId - name - isProduction - type - clientId '404': description: No environment exists with that id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get an organization environment operationId: getOrganizationEnvironment put: description: Update an environment, implemented as a patch. Note that only the name is allowed to be updated, isProduction and type can not. parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_environmentId_Path' requestBody: content: application/json: example: name: CoolEnvironmentsAround schema: type: object description: 'Request payload for updateOrganizationEnvironment.' properties: name: type: string description: 'The display name of the resource.' required: - name x-amf-mediaType: application/json description: Request payload for update environments2. responses: '200': description: Returns the updated environment x-amf-mediaType: application/json content: application/json: example: id: f0c9b011-980e-4928-9430-e60e3a97c043 organizationId: 70b3f7cb-614c-4276-b0cd-4f73db11602c name: Development isProduction: false type: sandbox clientId: abdf31490ba44484a1de789baf685e37 schema: type: object description: 'Response payload for updateOrganizationEnvironment.' properties: id: type: string description: 'The unique identifier of the resource.' organizationId: type: string description: 'The unique identifier of the organization.' name: type: string description: 'The display name of the resource.' isProduction: type: boolean description: 'Whether the environment is a production environment.' type: type: string description: 'The type of the resource.' clientId: type: string description: 'The unique identifier of the client application.' required: - id - organizationId - name - isProduction - type - clientId '404': description: No environment exists with that id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update an organization environment operationId: updateOrganizationEnvironment delete: description: Delete an environment parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_environmentId_Path' responses: '204': description: Successful. Returns zero length body '404': description: No environment exists with that id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete an environment operationId: deleteEnvironments /organizations/{organizationId}/environments/{environmentId}/clientManagementProviders: get: description: Retrieves client management providers for the environment parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_environmentId_Path' responses: '200': description: returns client management providerIds for the environment x-amf-mediaType: application/json content: application/json: example: suggestedClientManagementProviderIds: - 6a57bf06-9124-11e9-bc42-526af7764f64 schema: type: object description: 'Response payload for listEnvironmentsClientManagementProviders.' properties: suggestedClientManagementProviderIds: type: array description: 'Identifiers of the client management identity providers suggested for use with this organization.' items: type: string description: 'Identifiers of the client management identity providers suggested for use with this organization.' required: - suggestedClientManagementProviderIds '404': description: No environment exists with that id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List env client management providers operationId: listEnvClientProviders put: description: Upsert client providers for the environment parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_environmentId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnvironmentClientProviders' x-amf-mediaType: application/json description: Request payload for update environments client management providers. responses: '200': description: returns client management providerIds for the environment x-amf-mediaType: application/json content: application/json: example: suggestedClientManagementProviderIds: - 6a57bf06-9124-11e9-bc42-526af7764f64 schema: type: object description: 'Response payload for updateEnvironmentsClientManagementProviders.' properties: suggestedClientManagementProviderIds: type: array description: 'Identifiers of the client management identity providers suggested for use with this organization.' items: type: string description: 'Identifiers of the client management identity providers suggested for use with this organization.' required: - suggestedClientManagementProviderIds '404': description: No environment exists with that id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Upsert env client management providers operationId: upsertEnvClientProviders /organizations/{organizationId}/featureFlags: get: description: get all feature flags of an given organization parameters: - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '400': description: Bad parameter or other failure '404': description: Unknown organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List organization feature flags operationId: listFeatureFlags /organizations/{organizationId}/featureFlags/{featureFlagName}: get: description: API to get a feature flag for a given org. parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - name: featureFlagName required: true in: path schema: type: string description: The name of the feature flag to evaluate. responses: '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get an organization feature flag operationId: getFeatureFlags post: description: API to upsert a feature flag. parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - name: featureFlagName required: true in: path schema: type: string description: The name of the feature flag to evaluate. requestBody: content: application/json: schema: $ref: '#/components/schemas/FeatureFlagNew' x-amf-mediaType: application/json description: Request payload for create feature flags. responses: '200': description: Success '400': description: Bad Request '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Upsert an organization feature flag operationId: createFeatureFlags /organizations/{organizationId}/hierarchy: description: get related organizations in hierarchical structure get: description: get Business Groups (down to the leaves) of this organization. parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: name: MuleSoft Inc id: f0c9b011-980e-4928-9430-e60e3a97c043 createdAt: 2015-03-13 18:03:23.869000+00:00 updatedAt: 2015-03-13 18: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-13 18:03:28.663000+00:00 updatedAt: 2015-03-13 18: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-13 18:03:28.356000+00:00 updatedAt: 2015-03-13 18: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-13 18:03:28.407000+00:00 updatedAt: 2015-03-13 18: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-13 18:03:28.484000+00:00 updatedAt: 2015-03-13 18: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-13 18:03:28.525000+00:00 updatedAt: 2015-03-13 18: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-13 18:03:28.575000+00:00 updatedAt: 2015-03-13 18: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 schema: type: object description: 'Response payload for listHierarchy.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: string description: 'Identifiers of the organizations that are direct children of this organization.' tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' properties: type: object description: 'Additional properties associated with the resource.' properties: defaultAccessManagementUi: type: string description: 'The Access Management UI variant the organization defaults to.' required: - defaultAccessManagementUi environmentsCount: type: integer description: 'The number of environments configured for the organization.' owner: type: object description: 'The user or entity that owns the resource.' properties: id: type: string description: 'The unique identifier of the resource.' username: type: string description: 'The username used to authenticate the user.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email organizationId: type: string description: 'The unique identifier of the organization.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' required: - id - username - firstName - lastName - email - organizationId - enabled - idprovider_id subOrganizations: type: array description: 'The organizations that are direct children of this organization.' items: type: object description: 'The organizations that are direct children of this organization.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: string description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: object tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' subOrganizations: type: array description: 'The organizations that are direct children of this organization.' items: type: object environmentsCount: type: integer description: 'The number of environments configured for the organization.' owner: type: object description: 'The user or entity that owns the resource.' properties: id: type: string description: 'The unique identifier of the resource.' username: type: string description: 'The username used to authenticate the user.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email organizationId: type: string description: 'The unique identifier of the organization.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' required: - id - username - firstName - lastName - email - organizationId - enabled - idprovider_id required: - name - id - createdAt - updatedAt - ownerId - clientId - domain - idprovider_id - isFederated - parentOrganizationIds - subOrganizationIds - tenantOrganizationIds - isRoot - isMaster - subOrganizations - environmentsCount - owner required: - name - id - createdAt - updatedAt - ownerId - clientId - domain - idprovider_id - isFederated - parentOrganizationIds - subOrganizationIds - tenantOrganizationIds - isRoot - isMaster - properties - environmentsCount - owner - subOrganizations '400': description: Bad request; unknown organization. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get organization business group hierarchy operationId: listHierarchy /organizations/{organizationId}/identityProviders: get: description: Returns list of identity management providers for the root organization with a subset of values. parameters: - name: include_full_details description: If true, returns the full set of properties required: true in: query schema: type: boolean default: false - name: provider_id description: One or more ids of the provider(s) to return. required: false in: query style: form explode: false schema: type: array items: type: string - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: idp_type description: One or more types of provider(s) to return. required: false in: query style: form explode: false schema: type: array items: enum: - saml - openid - ldap type: string - name: ascending description: Whether to sort ascending or descending required: true in: query schema: type: boolean default: true - name: sort description: The field to sort on. required: false in: query schema: type: string enum: - provider_id - name default: provider_id - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - name: search description: A search string to use for case-insensitive partial matches on name required: false in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Returns the list of identity management providers x-amf-mediaType: application/json content: application/json: schema: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/ExternalIdentityProvidersFind' total: type: number example: 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 '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List identity providers operationId: listIdentityProviders post: description: Add a new identity management provider to the root organization. parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExternalIdentityProvider' x-amf-mediaType: application/json description: Request payload for create identity providers. responses: '201': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/ExternalIdentityProviderPostResponse' '400': description: Invalid data in body '405': description: Cannot add identity providers to business groups '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create an identity provider operationId: createIdentityProviders /organizations/{organizationId}/identityProviders/saml-sp-metadata: get: description: Download the SAML SP metadata of the associated SAML identity management provider parameters: - name: provider_id description: ID of the provider to get the associated SAML SP metadata. required: true in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/samlmetadata+xml content: application/samlmetadata+xml: example: "\n\n \n \n \n \n MIIEDzCCAvegAwIBAgIJALr9HwgrQ7GeMA0GCSqGSIb3DQEBBQUAMGIxGDAWBgNV\n\ BAMTD2F1dGgwLmF1dGgwLmNvbTESMBAGA1UEChMJQXV0aDAgTExDMQswCQYDVQQG\n\ EwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDAeFw0x\n\ MjEyMjkxNTMwNDdaFw0xMzAxMjgxNTMwNDdaMGIxGDAWBgNVBAMTD2F1dGgwLmF1\n\ dGgwLmNvbTESMBAGA1UEChMJQXV0aDAgTExDMQswCQYDVQQGEwJVUzETMBEGA1UE\n\ CBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDCCASIwDQYJKoZIhvcNAQEB\n\ BQADggEPADCCAQoCggEBAMZiVmNHiXLldrgbS50ONNOH7pJ2zg6OcSMkYZGDZJbO\n\ Z/TqwauC6JOnI7+xtkPJsQHZSFJs4U0srjZKzDCmaz2jLAJDShP2jaXlrki16nDL\n\ PE//IGAg3BJguSmBCWpDbSm92V9hSsE+Mhx6bDaJiw8yQ+Q8iSm0aTQZtp6O4ICM\n\ u00ESdh9NJqIECELvP31ADV1Xhj7IbyyVPDFxMv3ol5BySE9wwwOFUq/wv7Xz9LR\n\ iUjUzPO+Lq3OM3o/uCDbk7jD7XrGUuOydALD8ULsXp4EuDO+nFbeXB/iKndZynuV\n\ Kokirywl2nD2IP0/yncdLQZ8ByIyqP3G82fq/l8p7AsCAwEAAaOBxzCBxDAdBgNV\n\ HQ4EFgQUHI2rUXeBjTv1zAllaPGrHFcEK0YwgZQGA1UdIwSBjDCBiYAUHI2rUXeB\n\ jTv1zAllaPGrHFcEK0ahZqRkMGIxGDAWBgNVBAMTD2F1dGgwLmF1dGgwLmNvbTES\n\ MBAGA1UEChMJQXV0aDAgTExDMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGlu\n\ Z3RvbjEQMA4GA1UEBxMHUmVkbW9uZIIJALr9HwgrQ7GeMAwGA1UdEwQFMAMBAf8w\n\ DQYJKoZIhvcNAQEFBQADggEBAFrXIhCy4T4eGrikb0R2wHv/uS548r3pZyBV0CDb\n\ cRwAtbnpJMvkGFqKVp4pmyoIDSVNK/j+sLEshB20XftezHZyRJbCUbtKvXQ6Fsxo\n\ eZMlN0ITYKTaoBZKhUxxj90otAhNC58qwGUPqt2LewJhHyLucKkGJ1mQ3b5xKZ53\n\ 2ToufouH9VLhig3H1KnxWo/zMD6Ke8cCk6qO9htuhI06s3GQGS1QWQtAmm17C6Tf\n\ KgDwQFZwhqHUUZnwKRH8gU6OgZsvhgV1B7H5mjZcu57KMiDBekU9MEY0DCVTN3Wk\n\ mcTII668zLsJrkNX6PEfck1AMBbVE6pEUKcWwq3uaLvlAUo=\n\n\ \ \n \n \n\ \ \n \n \ \ \n MIIEDzCCAvegAwIBAgIJALr9HwgrQ7GeMA0GCSqGSIb3DQEBBQUAMGIxGDAWBgNV\n\ BAMTD2F1dGgwLmF1dGgwLmNvbTESMBAGA1UEChMJQXV0aDAgTExDMQswCQYDVQQG\n\ EwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDAeFw0x\n\ MjEyMjkxNTMwNDdaFw0xMzAxMjgxNTMwNDdaMGIxGDAWBgNVBAMTD2F1dGgwLmF1\n\ dGgwLmNvbTESMBAGA1UEChMJQXV0aDAgTExDMQswCQYDVQQGEwJVUzETMBEGA1UE\n\ CBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDCCASIwDQYJKoZIhvcNAQEB\n\ BQADggEPADCCAQoCggEBAMZiVmNHiXLldrgbS50ONNOH7pJ2zg6OcSMkYZGDZJbO\n\ Z/TqwauC6JOnI7+xtkPJsQHZSFJs4U0srjZKzDCmaz2jLAJDShP2jaXlrki16nDL\n\ PE//IGAg3BJguSmBCWpDbSm92V9hSsE+Mhx6bDaJiw8yQ+Q8iSm0aTQZtp6O4ICM\n\ u00ESdh9NJqIECELvP31ADV1Xhj7IbyyVPDFxMv3ol5BySE9wwwOFUq/wv7Xz9LR\n\ iUjUzPO+Lq3OM3o/uCDbk7jD7XrGUuOydALD8ULsXp4EuDO+nFbeXB/iKndZynuV\n\ Kokirywl2nD2IP0/yncdLQZ8ByIyqP3G82fq/l8p7AsCAwEAAaOBxzCBxDAdBgNV\n\ HQ4EFgQUHI2rUXeBjTv1zAllaPGrHFcEK0YwgZQGA1UdIwSBjDCBiYAUHI2rUXeB\n\ jTv1zAllaPGrHFcEK0ahZqRkMGIxGDAWBgNVBAMTD2F1dGgwLmF1dGgwLmNvbTES\n\ MBAGA1UEChMJQXV0aDAgTExDMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGlu\n\ Z3RvbjEQMA4GA1UEBxMHUmVkbW9uZIIJALr9HwgrQ7GeMAwGA1UdEwQFMAMBAf8w\n\ DQYJKoZIhvcNAQEFBQADggEBAFrXIhCy4T4eGrikb0R2wHv/uS548r3pZyBV0CDb\n\ cRwAtbnpJMvkGFqKVp4pmyoIDSVNK/j+sLEshB20XftezHZyRJbCUbtKvXQ6Fsxo\n\ eZMlN0ITYKTaoBZKhUxxj90otAhNC58qwGUPqt2LewJhHyLucKkGJ1mQ3b5xKZ53\n\ 2ToufouH9VLhig3H1KnxWo/zMD6Ke8cCk6qO9htuhI06s3GQGS1QWQtAmm17C6Tf\n\ KgDwQFZwhqHUUZnwKRH8gU6OgZsvhgV1B7H5mjZcu57KMiDBekU9MEY0DCVTN3Wk\n\ mcTII668zLsJrkNX6PEfck1AMBbVE6pEUKcWwq3uaLvlAUo=\n\n\ \ \n \n \n \ \ \n \n \n \n urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified\n\ \ \n \n\n" schema: type: string description: 'Response payload for listIdentityProvidersSamlSpMetadata.' '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Download SAML SP metadata operationId: listIdentityProvidersSamlSpMetadata /organizations/{organizationId}/identityProviders/ldap-test: post: description: Test the LDAP config before saving the configuration parameters: - name: provider_id description: ID of the provider to get the associated LDAP config that's already persisted required: false in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/LDAPProviderTest' x-amf-mediaType: application/json description: Request payload for create identity providers ldap test. responses: '200': description: Success '400': description: Invalid data in body '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Test LDAP identity provider config operationId: createIdentityProvidersLdapTest /organizations/{organizationId}/identityProviders/{identityProviderId}: get: description: Returns the associated identity management provider config. parameters: - name: include_secrets description: If true, include secrets in the response required: true in: query schema: type: boolean default: false - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_identityProviderId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/ExternalIdentityProviderGet' '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get an identity provider operationId: getIdentityProviders patch: description: Updates the associated identity management provider config parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_identityProviderId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExternalIdentityProviderPatch' x-amf-mediaType: application/json description: Request payload for update identity providers. responses: '200': description: Success '400': description: Invalid data in body '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update an identity provider operationId: updateIdentityProviders delete: description: Deletes the associated identity management provider parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_identityProviderId_Path' responses: '204': description: Success '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete an identity provider operationId: deleteIdentityProviders /organizations/{organizationId}/identityProviders/{identityProviderId}/saml-sp-keys: get: description: Returns the list of SAML SP keys associated to the identity management provider config parameters: - name: primary description: If true, return only the primary SAML SP key in: query schema: type: boolean default: false - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_identityProviderId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/SAMLProviderKeysArray' '404': description: The identity provider does not exist or is not a SAML provider '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List SAML SP keys operationId: listIdentityProvidersSamlSpKeys post: description: Add or generate a new SAML SP key pair parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_identityProviderId_Path' requestBody: content: application/json: schema: description: Key pair to add, or an empty body to generate a new key pair type: object additionalProperties: false properties: key_pair: type: object additionalProperties: false required: - private_key - certificate properties: private_key: type: string certificate: type: string x-amf-mediaType: application/json description: Request payload for create identity providers saml sp keys. responses: '201': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/SAMLProviderKeys' '404': description: The identity provider does not exist or is not a SAML provider '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Add or generate a SAML SP key operationId: createIdentityProvidersSamlSpKeys /organizations/{organizationId}/identityProviders/{identityProviderId}/saml-sp-keys/{samlSpKeyId}: get: description: Returns the SAML SP certificate in .pem format parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_identityProviderId_Path' - name: samlSpKeyId required: true in: path schema: type: string description: The unique identifier of the saml sp key id. responses: '200': description: Success x-amf-mediaType: binary/octet-stream content: binary/octet-stream: example: '-----BEGIN CERTIFICATE----- MIID2jCCAsICCQD4pI4hPjEsTjANBgkqhkiG9w0BAQ0FADCBrjELMAkGA1UEBhMC VVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28x FTATBgNVBAoMDE11bGVTb2Z0IEluYzEWMBQGA1UECwwNQ29yZSBTZXJ2aWNlczEe MBwGA1UEAwwVYW55cG9pbnQubXVsZXNvZnQuY29tMSMwIQYJKoZIhvcNAQkBFhRz dXBwb3J0QG11bGVzb2Z0LmNvbTAeFw0yMDA3MjkyMzU3NTZaFw0zMDA3MjkyMzU3 NTZaMIGuMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UE BwwNU2FuIEZyYW5jaXNjbzEVMBMGA1UECgwMTXVsZVNvZnQgSW5jMRYwFAYDVQQL DA1Db3JlIFNlcnZpY2VzMR4wHAYDVQQDDBVhbnlwb2ludC5tdWxlc29mdC5jb20x IzAhBgkqhkiG9w0BCQEWFHN1cHBvcnRAbXVsZXNvZnQuY29tMIIBIjANBgkqhkiG 9w0BAQEFAAOCAQ8AMIIBCgKCAQEApkYZoDdPZQRSP7w3v59xrKb3fqLkb5C5NZEZ Z5cWQqys2G40zDPdtIKn/VjEtFbyvnlmG7SWSnXixW4sAw2muemKKkphF8YFiq/C u14oJO+p6t4bvI61neQPKSj/bl1ZSnFLum4owX2afjVYiTbp3iBCMNlNRx2qTzix czpsgQPQAPnkx6fmIBM8IzrJqjFSbUUAV7SFh39ONtayIL/C6rm/GZMmR9AAEjuz FMEbg422htGSm/EjhulYY8/wGj8RThA/EkXLC0ScPUtvbaM23rnQklAqBzKxDu75 UfYgAgMNaGiwjMbzqte8tj+VCwEiQvD1QD8/HeZyCQpEVmqGTwIDAQABMA0GCSqG SIb3DQEBDQUAA4IBAQBCCH1ftf7Oftw8H5e4RCTY8GkNgOLOoaShu7+mb0Oca0ZS HDl0oXhFJE7iSTolHbEjMYg5nRNIPVhETNhwEEtRJ7IpU8STuerXRsbXv2TOdArR v7SWft+VoEFZodXzM0GU9Bnlq49LedwAgIi6/D7yrHx5qYFenRtWZKKsesNwB4D7 FLEknpmozxrDYFc9lIG/xbCeig8ElU2d3hU41EX3G83pIwQQBm0NHBi1KMXG50NB Kc/1/Sf7l4EqNqxYM6Akh0XUBiIgvWEjOvsEcONXoP5mODAq2We/bCQ3gUQrcPyE KrUDT/fzLzSTkLBGOGFHJfD3C88AlyiXCErArnlT -----END CERTIFICATE----- ' schema: type: string description: 'Response payload for getIdentityProvidersSamlSpKeys.' '404': description: The key or identity provider does not exist, or it is not a SAML provider '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get a SAML SP key operationId: getIdentityProvidersSamlSpKeys delete: description: Delete the SAML SP key parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_identityProviderId_Path' - name: samlSpKeyId required: true in: path schema: type: string description: The unique identifier of the saml sp key id. responses: '204': description: Success '404': description: The key or identity provider does not exist, or it is not a SAML provider '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete a SAML SP key operationId: deleteIdentityProvidersSamlSpKeys /organizations/{organizationId}/identityProviders/{identityProviderId}/saml-sp-keys/{samlSpKeyId}/setPrimary: post: description: Make the key the primary SAML SP key for the identity management provider config parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_identityProviderId_Path' - name: samlSpKeyId required: true in: path schema: type: string description: The unique identifier of the saml sp key id. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/SAMLProviderKeysArray' '404': description: The key or identity provider does not exist, or it is not a SAML provider '405': description: The organization is not a root organization '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Set primary SAML SP key operationId: setPrimarySamlSpKey /organizations/{organizationId}/identityProviderSettings: get: description: Get the identity provider settings for the org parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/IdentityProviderSettings' '405': description: The organization is not a root organization security: - bearerAuth: [] - clientAuth: [] summary: Get identity provider settings operationId: listIdentityProviderSettings patch: description: Update the identity provider settings for the org parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/IdentityProviderSettings' x-amf-mediaType: application/json description: Request payload for update identity provider settings. responses: '204': description: Success '400': description: Invalid data in body '405': description: The organization is not a root organization security: - bearerAuth: [] - clientAuth: [] summary: Update identity provider settings operationId: updateIdentityProviderSettings /organizations/{organizationId}/invites: description: Invite people to join the organization get: description: get outstanding or expired invites that match the criteria parameters: - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - name: search description: A search string to use for case-insensitive partial matches on invited emails required: false in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/Invite' total: type: number example: data: - id: 520 code: f2e8dfab-6699-4889-831f-6dc6f8428cb0 invited_at: 2015-01-30 22: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-10 22: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 '400': description: Bad request; unknown organization, bad parameter or other failure '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List organization invites operationId: listOrganizationInvites post: description: Invite a person to join the organization parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/InviteNewList' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/InviteList' '400': description: Bad request; unknown organization, bad parameter or other failure '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Invite a user to the organization operationId: createOrganizationInvite delete: description: Invite a person to join your organization parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/InvitesIds' responses: '204': description: Success '400': description: Bad request; unknown organization, bad parameter or no invite was deleted '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete organization invites operationId: deleteOrganizationInvites /organizations/{organizationId}/invites/{inviteId}: description: Invite resource get: description: get an invite parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - name: inviteId description: The ID of the invite required: true in: path schema: type: integer responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/Invite' '400': description: Bad request; bad parameter or other failure '404': description: No invite exists in this organization for the given inviteId '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get an organization invite operationId: getOrganizationInvite /organizations/{organizationId}/invites/resend: description: Resend invites post: description: Resend a list of invites parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/InvitesIds' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/InvitesResendResponse' '400': description: One or more of the invites are not in the organization or no invites were sent '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Resend organization invites operationId: resendOrganizationInvite /organizations/{organizationId}/members: description: Organization membership get: description: Get members from an organization parameters: - name: username description: Search users with the matching username required: true in: query schema: type: string - name: lastName description: Search users with the matching lastName required: true in: query schema: type: string - name: firstName description: Search users with the matching firstName required: true in: query schema: type: string - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - name: search description: Search string to find users. It will look up the string in the username, email, firstName and lastName required: true in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' x-amf-queryParameters: id: description: Search users with the matching id/ids. anyOf: - type: string - items: type: string responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for listMembers.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: id: type: string description: 'The unique identifier of the resource.' username: type: string description: 'The username used to authenticate the user.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email organizationId: type: string description: 'The unique identifier of the organization.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' type: type: string description: 'The type of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' password_updatedAt: type: string description: 'The date and time when the user''s password was last updated, in ISO 8601 format.' required: - id - username - firstName - lastName - email - organizationId - enabled - idprovider_id - type - createdAt - updatedAt - lastLogin - password_updatedAt total: type: integer description: 'The total number of items available across all pages.' required: - data - total '404': description: The organization does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List organization members operationId: listMembers put: description: Add a group of users to the organization by their IDs parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/Generated10' responses: '204': description: Success '400': description: Invalid IDs or some users could not be added to the org '404': description: The organization does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Add users to organization operationId: updateMembers delete: description: Remove a group of users from the organization by their IDs parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/Generated10' responses: '204': description: Success '400': description: Invalid IDs or some users could not be removed from the org '404': description: The organization does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Remove users from organization operationId: deleteMembers /organizations/{organizationId}/members/{userId}: put: description: Add the user to the organization parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_userId_Path' requestBody: $ref: '#/components/requestBodies/Generated10' responses: '204': description: Success '400': description: Invalid ID or this user could not be added to the org '404': description: The organization does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Add a user to organization operationId: updateOrganizationMember delete: description: Remove the user from the organization parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_userId_Path' requestBody: $ref: '#/components/requestBodies/Generated10' responses: '204': description: Success '400': description: Invalid ID or this user could not be removed from the org '404': description: The organization does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Remove a user from organization operationId: deleteOrganizationMember /organizations/{organizationId}/owner: description: Resource for owner of an organization get: description: get owner for an organization parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: id: 1cddca41-f396-423c-b5b8-f2951a5ff716 createdAt: 2015-07-28 00:05:57.605000+00:00 updatedAt: 2015-07-28 00:05:57.688000+00:00 lastLogin: 2015-07-29 00:05:57.688000+00:00 previousLastLogin: 2015-07-28 00: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 schema: type: object description: 'Response payload for listOwner.' properties: id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' previousLastLogin: type: string description: 'The date and time of the user''s previous successful login, in ISO 8601 format.' organizationId: type: string description: 'The unique identifier of the organization.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email phoneNumber: type: string description: 'The user''s phone number.' username: type: string description: 'The username used to authenticate the user.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' deleted: type: boolean description: 'Whether the resource has been marked as deleted.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' required: - id - createdAt - updatedAt - lastLogin - previousLastLogin - organizationId - firstName - lastName - email - phoneNumber - username - enabled - deleted - idprovider_id '400': description: Bad request; bad parameter or other failure '403': description: Forbidden; caller doesn't have the right permissions for specified action '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get organization owner operationId: listOwner /organizations/{organizationId}/owner/{userId}: description: Endpoint to switch organization owner to the one specified by userId put: description: Switch out organization's owner to the one specified by userId parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - name: userId required: true in: path schema: type: string description: The unique identifier of the user. x-origin: - api: urn:api:access-management operation: listOwner description: GET `/organizations/{organizationId}/owner` in this API; use `id` values as `userId`. values: $.id labels: $.name responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: id: 1cddca41-f396-423c-b5b8-f2951a5ff716 createdAt: 2015-07-28 00:05:57.605000+00:00 updatedAt: 2015-07-28 00:05:57.688000+00:00 lastLogin: 2015-07-29 00:05:57.688000+00:00 previousLastLogin: 2015-07-28 00: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 schema: type: object description: 'Response payload for updateOwner.' properties: id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' previousLastLogin: type: string description: 'The date and time of the user''s previous successful login, in ISO 8601 format.' organizationId: type: string description: 'The unique identifier of the organization.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email phoneNumber: type: string description: 'The user''s phone number.' username: type: string description: 'The username used to authenticate the user.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' deleted: type: boolean description: 'Whether the resource has been marked as deleted.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' required: - id - createdAt - updatedAt - lastLogin - previousLastLogin - organizationId - firstName - lastName - email - phoneNumber - username - enabled - deleted - idprovider_id '400': description: Bad request; bad parameter or other failure '403': description: Forbidden; caller doesn't have the right permissions for specified action '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Change organization owner operationId: updateOwner /organizations/{organizationId}/provider: parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' /organizations/{organizationId}/provider/users: description: Identity provider information for the organization get: description: Returns the identity provider details parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for listProviderUsers.' properties: identity_management: type: object description: 'Configuration of the identity management integration for the organization.' properties: type: type: object description: 'The type of the resource.' properties: name: type: string description: 'The display name of the resource.' description: type: string description: 'A human-readable description of the resource.' required: - name - description service_provider: type: object description: 'Configuration of the SAML service provider.' properties: name: type: string description: 'The display name of the resource.' urls: type: object description: 'URLs associated with the identity provider.' properties: sign_on: type: string description: 'URL the identity provider redirects to for single sign-on.' format: uri sign_out: type: string description: 'URL the identity provider redirects to for single sign-out.' format: uri required: - sign_on - sign_out required: - name - urls saml: type: object description: 'Configuration for the SAML identity provider.' properties: name: type: string description: 'The display name of the resource.' issuer: type: string description: 'The identifier of the entity that issued the token.' public_key: type: array description: 'The public key used to verify signatures issued by the resource.' items: type: string description: 'The public key used to verify signatures issued by the resource.' audience: type: string description: 'The audience (intended recipient) of the issued token, as defined by the OAuth 2.0 specification.' claims_mapping: type: object description: 'Mapping between identity provider claims and platform user attributes.' properties: group_attribute: type: string description: 'Name of the SAML/OIDC attribute that maps to platform group membership.' required: - group_attribute required: - name - issuer - public_key - audience - claims_mapping required: - type - service_provider - saml required: - identity_management '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get organization identity provider operationId: listProviderUsers put: description: Updates the identity provider for the organization parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExternalIdentityProviderLegacy' x-amf-mediaType: application/json description: Request payload for update provider users. responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update organization identity provider operationId: updateProviderUsers delete: description: Revert to using the default identity provider parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Reset organization identity provider operationId: deleteProviderUsers /organizations/{organizationId}/provider/users/ldap/test: post: description: To test the ldap identity provider configuration before persisting parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/LDAPProviderTestOld' x-amf-mediaType: application/json description: Request payload for create ldap test. responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Test LDAP provider configuration operationId: createLdapTest /organizations/{organizationId}/provider/users/saml-sp-metadata: get: description: Download the SAML SP metadata parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/samlmetadata+xml content: application/samlmetadata+xml: example: "\n\n \n \n \n \n MIIEDzCCAvegAwIBAgIJALr9HwgrQ7GeMA0GCSqGSIb3DQEBBQUAMGIxGDAWBgNV\n\ BAMTD2F1dGgwLmF1dGgwLmNvbTESMBAGA1UEChMJQXV0aDAgTExDMQswCQYDVQQG\n\ EwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDAeFw0x\n\ MjEyMjkxNTMwNDdaFw0xMzAxMjgxNTMwNDdaMGIxGDAWBgNVBAMTD2F1dGgwLmF1\n\ dGgwLmNvbTESMBAGA1UEChMJQXV0aDAgTExDMQswCQYDVQQGEwJVUzETMBEGA1UE\n\ CBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDCCASIwDQYJKoZIhvcNAQEB\n\ BQADggEPADCCAQoCggEBAMZiVmNHiXLldrgbS50ONNOH7pJ2zg6OcSMkYZGDZJbO\n\ Z/TqwauC6JOnI7+xtkPJsQHZSFJs4U0srjZKzDCmaz2jLAJDShP2jaXlrki16nDL\n\ PE//IGAg3BJguSmBCWpDbSm92V9hSsE+Mhx6bDaJiw8yQ+Q8iSm0aTQZtp6O4ICM\n\ u00ESdh9NJqIECELvP31ADV1Xhj7IbyyVPDFxMv3ol5BySE9wwwOFUq/wv7Xz9LR\n\ iUjUzPO+Lq3OM3o/uCDbk7jD7XrGUuOydALD8ULsXp4EuDO+nFbeXB/iKndZynuV\n\ Kokirywl2nD2IP0/yncdLQZ8ByIyqP3G82fq/l8p7AsCAwEAAaOBxzCBxDAdBgNV\n\ HQ4EFgQUHI2rUXeBjTv1zAllaPGrHFcEK0YwgZQGA1UdIwSBjDCBiYAUHI2rUXeB\n\ jTv1zAllaPGrHFcEK0ahZqRkMGIxGDAWBgNVBAMTD2F1dGgwLmF1dGgwLmNvbTES\n\ MBAGA1UEChMJQXV0aDAgTExDMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGlu\n\ Z3RvbjEQMA4GA1UEBxMHUmVkbW9uZIIJALr9HwgrQ7GeMAwGA1UdEwQFMAMBAf8w\n\ DQYJKoZIhvcNAQEFBQADggEBAFrXIhCy4T4eGrikb0R2wHv/uS548r3pZyBV0CDb\n\ cRwAtbnpJMvkGFqKVp4pmyoIDSVNK/j+sLEshB20XftezHZyRJbCUbtKvXQ6Fsxo\n\ eZMlN0ITYKTaoBZKhUxxj90otAhNC58qwGUPqt2LewJhHyLucKkGJ1mQ3b5xKZ53\n\ 2ToufouH9VLhig3H1KnxWo/zMD6Ke8cCk6qO9htuhI06s3GQGS1QWQtAmm17C6Tf\n\ KgDwQFZwhqHUUZnwKRH8gU6OgZsvhgV1B7H5mjZcu57KMiDBekU9MEY0DCVTN3Wk\n\ mcTII668zLsJrkNX6PEfck1AMBbVE6pEUKcWwq3uaLvlAUo=\n\n\ \ \n \n \n\ \ \n \n \ \ \n MIIEDzCCAvegAwIBAgIJALr9HwgrQ7GeMA0GCSqGSIb3DQEBBQUAMGIxGDAWBgNV\n\ BAMTD2F1dGgwLmF1dGgwLmNvbTESMBAGA1UEChMJQXV0aDAgTExDMQswCQYDVQQG\n\ EwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDAeFw0x\n\ MjEyMjkxNTMwNDdaFw0xMzAxMjgxNTMwNDdaMGIxGDAWBgNVBAMTD2F1dGgwLmF1\n\ dGgwLmNvbTESMBAGA1UEChMJQXV0aDAgTExDMQswCQYDVQQGEwJVUzETMBEGA1UE\n\ CBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDCCASIwDQYJKoZIhvcNAQEB\n\ BQADggEPADCCAQoCggEBAMZiVmNHiXLldrgbS50ONNOH7pJ2zg6OcSMkYZGDZJbO\n\ Z/TqwauC6JOnI7+xtkPJsQHZSFJs4U0srjZKzDCmaz2jLAJDShP2jaXlrki16nDL\n\ PE//IGAg3BJguSmBCWpDbSm92V9hSsE+Mhx6bDaJiw8yQ+Q8iSm0aTQZtp6O4ICM\n\ u00ESdh9NJqIECELvP31ADV1Xhj7IbyyVPDFxMv3ol5BySE9wwwOFUq/wv7Xz9LR\n\ iUjUzPO+Lq3OM3o/uCDbk7jD7XrGUuOydALD8ULsXp4EuDO+nFbeXB/iKndZynuV\n\ Kokirywl2nD2IP0/yncdLQZ8ByIyqP3G82fq/l8p7AsCAwEAAaOBxzCBxDAdBgNV\n\ HQ4EFgQUHI2rUXeBjTv1zAllaPGrHFcEK0YwgZQGA1UdIwSBjDCBiYAUHI2rUXeB\n\ jTv1zAllaPGrHFcEK0ahZqRkMGIxGDAWBgNVBAMTD2F1dGgwLmF1dGgwLmNvbTES\n\ MBAGA1UEChMJQXV0aDAgTExDMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGlu\n\ Z3RvbjEQMA4GA1UEBxMHUmVkbW9uZIIJALr9HwgrQ7GeMAwGA1UdEwQFMAMBAf8w\n\ DQYJKoZIhvcNAQEFBQADggEBAFrXIhCy4T4eGrikb0R2wHv/uS548r3pZyBV0CDb\n\ cRwAtbnpJMvkGFqKVp4pmyoIDSVNK/j+sLEshB20XftezHZyRJbCUbtKvXQ6Fsxo\n\ eZMlN0ITYKTaoBZKhUxxj90otAhNC58qwGUPqt2LewJhHyLucKkGJ1mQ3b5xKZ53\n\ 2ToufouH9VLhig3H1KnxWo/zMD6Ke8cCk6qO9htuhI06s3GQGS1QWQtAmm17C6Tf\n\ KgDwQFZwhqHUUZnwKRH8gU6OgZsvhgV1B7H5mjZcu57KMiDBekU9MEY0DCVTN3Wk\n\ mcTII668zLsJrkNX6PEfck1AMBbVE6pEUKcWwq3uaLvlAUo=\n\n\ \ \n \n \n \ \ \n \n \n \n urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified\n\ \ \n \n\n" schema: type: string description: 'Response payload for listProviderUsersSamlSpMetadata.' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Download organization SAML SP metadata operationId: listProviderUsersSamlSpMetadata /organizations/{organizationId}/proxyusers/{userId}: description: Creates a proxy user in an organization post: description: Creates a proxy user in an organization parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - name: userId required: true in: path schema: type: string description: The unique identifier of the user. responses: '201': description: Success x-amf-mediaType: application/json content: application/json: example: 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-24 00:36:58+00:00 updatedAt: 2019-09-24 00:36:58+00:00 organizationId: f0c9b011-980e-4928-9430-e60e3a97c043 schema: type: object description: 'Response payload for createProxyusers.' properties: id: type: string description: 'The unique identifier of the resource.' username: type: string description: 'The username used to authenticate the user.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' deleted: type: boolean description: 'Whether the resource has been marked as deleted.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' type: type: string description: 'The type of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' organizationId: type: string description: 'The unique identifier of the organization.' required: - id - username - firstName - lastName - email - enabled - deleted - idprovider_id - type - createdAt - updatedAt - organizationId '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create an organization proxy user operationId: createProxyusers /organizations/{organizationId}/rolegroups: description: Role groups that belong to this organization get: description: Returns all role groups that belong to this organization parameters: - name: displayProviderId description: if true, force display of the provider_id property of external names required: false in: query schema: type: boolean - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for listRolegroups.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: role_group_id: type: string description: 'The unique identifier of the role group (legacy term for team).' name: type: string description: 'The display name of the resource.' description: type: string description: 'A human-readable description of the resource.' context_params: type: object description: 'Additional parameters that scope the operation to a specific organization or environment.' properties: {} user_role_group_id: type: string description: 'The unique identifier of the role-group assignment for the user.' required: - role_group_id - name - description - context_params - user_role_group_id total: type: integer description: 'The total number of items available across all pages.' required: - data - total '404': description: The organization does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List role groups operationId: listRolegroups post: description: Creates a role group for this org parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: content: application/json: example: name: Organization Administrators description: Organization Administrators external_names: - external_group_name: administrators provider_id: 2e50e859-0042-46ff-8cf8-1ad6f0c78b67 schema: type: object description: 'Request payload for createRolegroups.' properties: name: type: string description: 'The display name of the resource.' description: type: string description: 'A human-readable description of the resource.' external_names: type: array description: 'Alternative names by which the resource is known in external systems.' items: type: object description: 'Alternative names by which the resource is known in external systems.' properties: external_group_name: type: string description: 'The name of the group as defined in the external identity provider.' provider_id: type: string description: 'The unique identifier of the identity provider.' required: - external_group_name - provider_id required: - name - description - external_names x-amf-mediaType: application/json description: Request payload for create rolegroups. responses: '201': description: Success x-amf-mediaType: application/json content: application/json: example: 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-02 22:27:50.593000+00:00 updated_at: 2015-02-02 22:27:50.593000+00:00 schema: type: object description: 'Response payload for createRolegroups.' properties: role_group_id: type: string description: 'The unique identifier of the role group (legacy term for team).' name: type: string description: 'The display name of the resource.' external_names: type: array description: 'Alternative names by which the resource is known in external systems.' items: type: string description: 'Alternative names by which the resource is known in external systems.' description: type: string description: 'A human-readable description of the resource.' org_id: type: string description: 'The unique identifier of the organization.' editable: type: boolean description: 'Whether the resource can be edited by the current user.' created_at: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updated_at: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' required: - role_group_id - name - external_names - description - org_id - editable - created_at - updated_at '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create a role group operationId: createRolegroups delete: description: Deletes role groups that belong to this organization parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/Generated10' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete role groups operationId: deleteRolegroups /organizations/{organizationId}/rolegroups/{roleGroupId}: get: description: Returns a role group parameters: - name: displayProviderId description: if true, force display of the provider_id property of external names required: false in: query schema: type: boolean - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_roleGroupId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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-02 22:27:50.593000+00:00 updated_at: 2015-02-02 22:27:50.593000+00:00 schema: type: object description: 'Response payload for getRolegroups.' properties: role_group_id: type: string description: 'The unique identifier of the role group (legacy term for team).' name: type: string description: 'The display name of the resource.' external_names: type: array description: 'Alternative names by which the resource is known in external systems.' items: type: string description: 'Alternative names by which the resource is known in external systems.' description: type: string description: 'A human-readable description of the resource.' org_id: type: string description: 'The unique identifier of the organization.' editable: type: boolean description: 'Whether the resource can be edited by the current user.' created_at: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updated_at: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' required: - role_group_id - name - external_names - description - org_id - editable - created_at - updated_at '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get a role group operationId: getRolegroups put: description: Updates a role group parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_roleGroupId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/RoleGroupUpdate' x-amf-mediaType: application/json description: Request payload for update rolegroups. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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-02 22:27:50.593000+00:00 updated_at: 2015-02-02 22:27:50.593000+00:00 schema: type: object description: 'Response payload for updateRolegroups.' properties: role_group_id: type: string description: 'The unique identifier of the role group (legacy term for team).' name: type: string description: 'The display name of the resource.' external_names: type: array description: 'Alternative names by which the resource is known in external systems.' items: type: string description: 'Alternative names by which the resource is known in external systems.' description: type: string description: 'A human-readable description of the resource.' org_id: type: string description: 'The unique identifier of the organization.' editable: type: boolean description: 'Whether the resource can be edited by the current user.' created_at: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updated_at: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' required: - role_group_id - name - external_names - description - org_id - editable - created_at - updated_at '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update a role group operationId: updateRolegroups delete: description: Deletes a role group parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_roleGroupId_Path' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete a role group operationId: deleteOrganizationRolegroup /organizations/{organizationId}/rolegroups/{roleGroupId}/roles: description: Roles assigned to this role group get: description: Returns all roles assigned to this role group parameters: - name: namepace description: return only role assignments where a role contains a permission that is part of the given namespace required: false in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_roleGroupId_Path' x-amf-queryParameters: role_id: description: return only role assignments containing one of the supplied role_ids required: false anyOf: - type: string - items: type: string namespaces: description: return only role assignments where a role belongs to the given namespace required: false anyOf: - type: string - items: type: string responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: data: - created_at: 2015-02-02 21: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 schema: type: object description: 'Response payload for listRolegroupsRoles.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: created_at: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' role_group_assignment_id: type: string description: 'The unique identifier of the role-group assignment.' role_group_id: type: string description: 'The unique identifier of the role group (legacy term for team).' role_id: type: string description: 'The unique identifier of the role.' name: type: string description: 'The display name of the resource.' description: type: string description: 'A human-readable description of the resource.' internal: type: boolean description: 'Whether the resource is for internal use only.' org_id: type: string description: 'The unique identifier of the organization.' context_params: type: object description: 'Additional parameters that scope the operation to a specific organization or environment.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' required: - org required: - created_at - role_group_assignment_id - role_group_id - role_id - name - description - internal - org_id - context_params total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List roles in a role group operationId: listRolegroupsRoles post: description: Assigns roles to this role group parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_roleGroupId_Path' requestBody: $ref: '#/components/requestBodies/Generated11' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Assign roles to a role group operationId: createRolegroupsRoles delete: description: Removes roles from this role group parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_roleGroupId_Path' requestBody: $ref: '#/components/requestBodies/Generated11' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Unassign roles from a role group operationId: deleteRolegroupsRoles /organizations/{organizationId}/rolegroups/{roleGroupId}/users: description: Users assigned to this role group get: description: Returns users assigned to this role group parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_roleGroupId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for listRolegroupsUsers.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: id: type: string description: 'The unique identifier of the resource.' username: type: string description: 'The username used to authenticate the user.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email organizationId: type: string description: 'The unique identifier of the organization.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' context_params: type: object description: 'Additional parameters that scope the operation to a specific organization or environment.' properties: {} required: - id - username - firstName - lastName - email - organizationId - enabled - idprovider_id - context_params total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List users in a role group operationId: listRolegroupsUsers post: description: Assigns a group of users to this role group parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_roleGroupId_Path' requestBody: $ref: '#/components/requestBodies/Generated10' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Assign users to a role group operationId: createRolegroupsUsers delete: description: Unassigns a group of users from this role group parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_roleGroupId_Path' requestBody: $ref: '#/components/requestBodies/Generated10' responses: '200': description: Success '409': description: Could not unassign role group '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Unassign users from a role group operationId: deleteRolegroupsUsers /organizations/{organizationId}/rolegroups/{roleGroupId}/users/{userId}: post: description: Assigns this user to the role group parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_roleGroupId_Path' - $ref: '#/components/parameters/XOrigin_rolegroupUserId_Path' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Assign a user to a role group operationId: addUserToOrganizationRolegroup delete: description: Removes this user from the role group parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_roleGroupId_Path' - $ref: '#/components/parameters/XOrigin_rolegroupUserId_Path' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Remove a user from a role group operationId: removeUserFromOrganizationRolegroup /organizations/{organizationId}/roles: description: Roles by organization delete: description: Remove assignments for a given context, the context for the roles being deleted should be sent on the query string parameters: - name: match description: 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). required: true in: query schema: type: string enum: - exact - partial - name: <> description: Target role assignments should have the context parameter name/value pair. At least one parameter that is not 'org' or 'envId' must be provided. required: true in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '204': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete role assignments operationId: deleteRoles /organizations/{organizationId}/smtp: description: SMTP information for the organization get: description: Returns the SMTP details parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: host: smtp.gmail.com port: 465 secure: true ignoreTLS: false username: admin password: admin fromName: John Galt fromAddress: john.galt@gmail.com schema: type: object description: 'Response payload for listSmtp.' properties: host: type: string description: 'The hostname of the server.' port: type: integer description: 'The port on which the server is reachable.' secure: type: boolean description: 'Whether the connection should use TLS.' ignoreTLS: type: boolean description: 'Whether TLS certificate validation should be skipped for the connection.' username: type: string description: 'The username used to authenticate the user.' password: type: string description: 'The user''s password. Write-only.' fromName: type: string description: 'The display name used in the from address of outbound emails.' fromAddress: type: string description: 'The from address used in outbound emails.' format: email required: - host - port - secure - ignoreTLS - username - password - fromName - fromAddress '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get organization SMTP settings operationId: listSmtp put: description: Updates the SMTP details parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: content: application/json: example: host: smtp.gmail.com port: 465 secure: true ignoreTLS: false username: admin password: admin fromName: John Galt fromAddress: john.galt@gmail.com schema: type: object description: 'Request payload for updateSmtp.' properties: host: type: string description: 'The hostname of the server.' port: type: integer description: 'The port on which the server is reachable.' secure: type: boolean description: 'Whether the connection should use TLS.' ignoreTLS: type: boolean description: 'Whether TLS certificate validation should be skipped for the connection.' username: type: string description: 'The username used to authenticate the user.' password: type: string description: 'The user''s password. Write-only.' fromName: type: string description: 'The display name used in the from address of outbound emails.' fromAddress: type: string description: 'The from address used in outbound emails.' format: email required: - host - port - secure - ignoreTLS - username - password - fromName - fromAddress x-amf-mediaType: application/json description: Request payload for update smtp. responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update organization SMTP settings operationId: updateSmtp /organizations/{organizationId}/teams: description: Teams are groups of users and/or other teams get: description: Returns all teams or search for teams or get a list of teams by ids parameters: - name: ancestor_team_id description: team_id that must appear in the team's ancestor_team_ids. in: query style: form explode: false schema: type: array items: type: string - name: team_id description: '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 ' in: query style: form explode: false schema: type: array items: type: string - name: parent_team_id description: team_id of the immediate parent of the team to return. in: query style: form explode: false schema: type: array items: type: string - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: ascending description: Whether to sort ascending or descending required: true in: query schema: type: boolean default: true - name: team_type description: 'One or more types of team(s) to return. Type should be teams.TeamType but Osprey can''t handle custom types in query params ' in: query style: form explode: false schema: type: array items: type: string - name: sort description: The field to sort on. required: false in: query schema: type: string enum: - team_name - created_at - team_id default: team_name - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - name: search description: A search string to use for case-insensitive partial matches on team name required: false in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/Team' total: type: number example: 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-15 09:36:07.123000+00:00 updated_at: 2019-07-15 09:36:07.123000+00:00 total: 1 '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List teams operationId: listTeams post: description: Creates a new team. parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/TeamCreate' x-amf-mediaType: application/json description: Request payload for create teams. responses: '201': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/Team' '409': description: No team for the parent_team_id or the type of the parent_team_id is incompatible with this team's type. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create a team operationId: createTeams /organizations/{organizationId}/teams/{teamId}: get: description: Returns the team parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/Team' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get a team operationId: getTeams patch: description: Update or move the team parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/TeamUpdate' x-amf-mediaType: application/json description: Request payload for update teams. responses: '201': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/Team' '401': description: Not Authorized to either update the properties on the team. '409': description: '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. ' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update a team operationId: updateTeams delete: description: Delete the team, including all child teams. parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' responses: '204': description: Success. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete a team operationId: deleteTeams /organizations/{organizationId}/teams/{teamId}/parent: put: description: Move the team and its child teams under a new parent team parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/TeamMove' x-amf-mediaType: application/json description: Request payload for update teams parent. responses: '201': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/Team' '401': description: Not Authorized to move the team or move the team under the new parent_team_id '409': description: If no team exists for the parent_team_id or the type of the parent_team_id is incompatible with this team's type. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Move a team under a new parent operationId: updateTeamsParent /organizations/{organizationId}/teams/{teamId}/groupmappings: description: 'group access mappings configure how memberships in external groups relate to memberships in teams ' get: description: | Get all group access mappings configured for the team. **Required Scope:** `view:access_controls` (for connected apps) parameters: - name: membership_type? description: Include the group access mappings that grant the provided membership type By default, all group access mappings are returned required: false in: query style: form explode: false schema: type: array items: enum: - member - maintainer type: string - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - name: search description: A search string to use for case-insensitive partial matches on external group name required: false in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' x-amf-queryParameters: provider_id?: description: Include the group access mappings that are mapped to the provided IdP By default, all group access mappings are returned required: false anyOf: - type: string pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' - items: type: string pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/TeamExternalGroupMapping' total: type: number example: 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 '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List team group mappings operationId: listTeamsGroupmappings put: description: | Replace the entire list of group mappings associated with this team. **Required Scope:** `admin:access_controls` (for connected apps) parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' requestBody: $ref: '#/components/requestBodies/TeamExternalGroupMappingList' responses: '204': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Replace team group mappings operationId: updateTeamsGroupmappings patch: description: | Bulk add mappings and/or modify mappings' membership_type to the team. Removing mappings is not supported by this method. **Required Scope:** `admin:access_controls` (for connected apps) parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' requestBody: $ref: '#/components/requestBodies/TeamExternalGroupMappingList' responses: '204': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Bulk add team group mappings operationId: updateOrganizationTeamGroupmappings delete: description: | Bulk remove mappings from the team. **Required Scope:** `admin:access_controls` (for connected apps) parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' requestBody: $ref: '#/components/requestBodies/TeamExternalGroupMappingList' responses: '204': description: Success. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Bulk remove team group mappings operationId: deleteTeamsGroupmappings /organizations/{organizationId}/teams/{teamId}/roles: description: roles assigned to the team. All members of the team receive these access control grants. get: description: get all role assignments or search for role assignments parameters: - name: role_id description: return only role assignments containing one of the supplied role_ids required: false in: query style: form explode: false schema: type: array items: type: string - name: search description: A search string to use for case-insensitive partial matches on role name required: false in: query schema: type: string - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/RoleAssignmentDetailed' total: type: number example: 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 '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List team role assignments operationId: listTeamsRoles post: description: bulk assign roles to the team parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' requestBody: $ref: '#/components/requestBodies/RoleAssignmentCollectionRequest' responses: '204': description: Success '400': description: Invalid role_id or context_parameters. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Bulk assign roles to a team operationId: createTeamsRoles delete: description: bulk unassign roles from the team parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' requestBody: $ref: '#/components/requestBodies/RoleAssignmentCollectionRequest' responses: '204': description: Success '400': description: Invalid role_id or context_parameters. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Bulk unassign roles from a team operationId: deleteTeamsRoles /organizations/{organizationId}/teams/{teamId}/members: description: members of teams can be users or other teams get: description: get all members or search for members of this team or get a list of members by ids parameters: - name: membership_type description: 'Include the members of the team that have this membership_type. By default, all types of members are returned. ' required: false in: query style: form explode: false schema: type: array items: type: string - name: identity_type description: 'Include the members of the team that have this type. By default, all types of members are returned. ' required: false in: query style: form explode: false schema: type: array items: type: string - name: displayUserDetails description: If true, include additional user fields. Only compatible with the user identity_type required: false in: query schema: type: boolean default: false - name: member_ids description: Include the members of the team that have ids in this list required: false in: query style: form explode: false schema: type: array items: type: string - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: ascending description: Whether to sort ascending or descending required: true in: query schema: type: boolean default: true - name: sort description: The field to sort on. required: false in: query schema: type: string enum: - identity_type - name default: identity_type - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - name: search description: A search string to use for case-insensitive partial matches on member name required: false in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/TeamMember' total: type: number example: 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-15 09:36:07.123000+00:00 updated_at: 2019-07-15 09:36:07.123000+00:00 total: 1 '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List team members operationId: listTeamsMembers patch: description: bulk add users and/or modify users' membership_type to the team. Removing members is not supported by this method. parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/TeamMemberBulkAdd' x-amf-mediaType: application/json description: Request payload for update teams members. responses: '204': description: Success '400': description: Returned if any member id is for a team. Use the endpoints directly on the team to move it or delete it. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Bulk add team members operationId: updateTeamsMembers delete: description: bulk remove user members from the team parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/TeamMemberIdArray' x-amf-mediaType: application/json description: Request payload for delete teams members. responses: '204': description: Success. '400': description: Returned if any member id is for a team. Use the endpoints directly on the team to move it or delete it. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Bulk remove team members operationId: deleteTeamsMembers /organizations/{organizationId}/teams/{teamId}/members/{userId}: put: description: add the user as a member of the team. parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' - $ref: '#/components/parameters/XOrigin_teamMemberId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/TeamMemberAdd' x-amf-mediaType: application/json description: Request payload for update teams members2. responses: '204': description: Success. '405': description: Returned if the member id is for a team. Use the endpoints directly on the team to move it or delete it. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Add a user to a team operationId: updateOrganizationTeamMember delete: description: remove the user from the team. parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_teamId_Path' - $ref: '#/components/parameters/XOrigin_teamMemberId_Path' responses: '204': description: Success. '405': description: Returned if the member id is for a team. Use the endpoints directly on the team to move it or delete it. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Remove a user from a team operationId: removeOrganizationTeamMember /organizations/{organizationId}/tenantRelationships: get: description: List Tenant Relationships by Root Organization parameters: - name: enabled description: Used to filter by whether tenant relationship is enabled in: query schema: type: boolean - name: incomingTrust description: Used to filter by incoming trust value in: query schema: type: string - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: outgoingTrust description: Used to filter by outgoing trust value in: query schema: type: string - name: ascending description: Whether to sort ascending or descending required: true in: query schema: type: boolean default: true - name: rel_type description: Used to filter by type of Tenant Relationship in: query style: form explode: false schema: type: array items: type: string - name: tenantKey description: Used to filter by tenantKey value in: query style: form explode: false schema: type: array items: type: string - name: sort description: The field to sort on. required: false in: query schema: type: string enum: - label - createdAt default: label - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/TenantRelationship' total: type: number example: 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-14 22:33:24+00:00 updatedAt: 2023-08-14 22:33:24+00:00 config: _type: SFDC_C2C incomingTrusts: - sfdc.manageMuleSoftTenantConnection outgoingTrusts: [] apiEndpoint: https://example.my.salesforce.com total: 1 '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List tenant relationships operationId: listTenantRelationships post: description: Establish manual tenant relationships parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/ManualTenantRelationshipRequest' x-amf-mediaType: application/json description: Request payload for create tenant relationships. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/SingleTenantRelationshipResponse' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create a tenant relationship operationId: createTenantRelationships /organizations/{organizationId}/tenantRelationships/{relationshipId}: get: description: Get a particular Tenant Relationship by ID parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - name: relationshipId description: id of the Tenant Relationship required: true in: path schema: type: string minLength: 1 maxLength: 255 responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/SingleTenantRelationshipResponse' '401': description: Authentication Required '403': description: Not Authorized '404': description: No such Tenant Relationship security: - bearerAuth: [] - clientAuth: [] summary: Get a tenant relationship operationId: getTenantRelationships patch: description: Patch update a particular Tenant Relationship by ID parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - name: relationshipId description: id of the Tenant Relationship required: true in: path schema: type: string minLength: 1 maxLength: 255 requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchTenantRelationshipRequest' x-amf-mediaType: application/json description: Request payload for update tenant relationships. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/SingleTenantRelationshipResponse' '401': description: Authentication Required '403': description: Not Authorized '404': description: No such Tenant Relationship security: - bearerAuth: [] - clientAuth: [] summary: Update a tenant relationship operationId: updateTenantRelationships delete: description: Delete a particular Tenant Relationship by ID parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - name: relationshipId description: id of the Tenant Relationship required: true in: path schema: type: string minLength: 1 maxLength: 255 responses: '204': description: Success '401': description: Authentication Required '403': description: Not Authorized '404': description: No such Tenant Relationship security: - bearerAuth: [] - clientAuth: [] summary: Delete a tenant relationship operationId: deleteTenantRelationships /organizations/{organizationId}/tenantRelationships/{relationshipId}/repair: patch: description: Repairs certain types of connection errors between the MuleSoft org and the remote Tenant parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - name: relationshipId description: id of the Tenant Relationship required: true in: path schema: type: string minLength: 1 maxLength: 255 responses: '200': description: Success '400': description: Bad Request '401': description: Authentication Required '403': description: Not Authorized '404': description: No such Tenant Relationship '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Repair a tenant relationship operationId: updateTenantRelationshipsRepair /organizations/{organizationId}/myTenantRelationship: parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' /organizations/{organizationId}/myTenantRelationship/{statusKey}: parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - name: statusKey description: The key identifying the specific tenant relationship status feature (e.g., SFDC organization feature). required: true in: path schema: type: string /organizations/{organizationId}/myTenantRelationship/{statusKey}/status: put: description: Update the status of a specific SFDC organization feature for tenant relationships parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - name: statusKey required: true in: path schema: type: string description: The unique identifier of the status key. requestBody: content: application/json: schema: $ref: '#/components/schemas/SetSFDCOrgStatusRequest' x-amf-mediaType: application/json description: Request payload for update my tenant relationship status. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: {} schema: type: object description: 'Response payload for updateMyTenantRelationshipStatus.' properties: {} '400': description: Bad Request '401': description: Authentication Required '403': description: Not Authorized '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update tenant relationship status operationId: updateMyTenantRelationshipStatus /organizations/{organizationId}/myTenantRelationship/assignments: get: description: Get business group assignments for the Tenant Relationship for the caller utilizing a C2C token parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for listMyTenantRelationshipAssignments.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: trust: type: string description: 'Whether the resource is trusted by the platform.' context_params: type: array description: 'Additional parameters that scope the operation to a specific organization or environment.' items: type: object description: 'Additional parameters that scope the operation to a specific organization or environment.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' required: - org required: - trust - context_params total: type: integer description: 'The total number of items available across all pages.' required: - data - total '401': description: Authentication Required '403': description: Not Authorized '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List tenant relationship assignments operationId: listMyTenantRelationshipAssignments /organizations/{organizationId}/users: description: Users that belong to the organization get: description: Returns a group of users that belong to the organization parameters: - name: type description: Specify the type of user you want to retrieve. required: true in: query schema: type: string enum: - host - proxy - all default: host - name: mfaVerificationExcluded description: Specify if you want to retrieve only users with a given mfaVerificationExcluded value required: true in: query schema: type: boolean - name: search description: The query string to search for an user by username, firstName, lastName or email required: false in: query schema: type: string - name: deleted description: Specify if you want to retrieve only deleted required: true in: query schema: type: boolean default: false - $ref: '#/components/parameters/XOrigin_organizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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-03 00:20:06.125000+00:00 ownerId: 57e281b5-ec5b-4701-80a0-92a936a68da3 updatedAt: 2015-02-03 00: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-27 20:56:02.125000+00:00 isApiConsumer: false total: 1 schema: type: object description: 'Response payload for listUsers.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: id: type: string description: 'The unique identifier of the resource.' username: type: string description: 'The username used to authenticate the user.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email email_verified_at: type: 'null' description: 'The date and time when the user''s email address was verified, in ISO 8601 format.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' type: type: string description: 'The type of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' organizationId: type: string description: 'The unique identifier of the organization.' organization: type: object description: 'The organization that owns the resource.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' properties: type: object description: 'Additional properties associated with the resource.' properties: defaultAccessManagementUi: type: string description: 'The Access Management UI variant the organization defaults to.' required: - defaultAccessManagementUi entitlements: type: object description: 'The features and capabilities the organization is entitled to use.' properties: createSubOrgs: type: boolean description: 'Whether the organization is allowed to create sub-organizations.' createEnvironments: type: boolean description: 'Whether the organization is allowed to create environments.' hybrid: type: object description: 'Whether hybrid deployments are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled hybridInsight: type: boolean description: 'Whether Hybrid Insight is available to the organization.' hybridAutoDiscoverProperties: type: boolean description: 'Whether hybrid runtimes can auto-discover platform properties.' globalDeployment: type: boolean description: 'Whether the entitlement allows global deployment of MuleSoft applications.' vCoresProduction: type: object description: 'Number of production vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresSandbox: type: object description: 'Number of sandbox vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresDesign: type: object description: 'Number of design-time vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned staticIps: type: object description: 'Number of static IPs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpcs: type: object description: 'Number of Anypoint VPCs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpns: type: object description: 'Number of VPN connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned networkConnections: type: object description: 'Number of network connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned workerLoggingOverride: type: object description: 'Whether the organization can override worker logging configuration.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled messaging: type: object description: 'Whether Anypoint MQ is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned mqMessages: type: object description: 'Number of Anypoint MQ messages included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqRequests: type: object description: 'Number of Anypoint MQ requests included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqAdvancedFeatures: type: object description: 'Whether Anypoint MQ advanced features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled objectStoreRequestUnits: type: object description: 'Number of Object Store request units included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn objectStoreKeys: type: object description: 'Number of Object Store keys included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn gateways: type: object description: 'Number of API gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned designCenter: type: object description: 'Whether Anypoint Design Center is available to the organization.' properties: mozart: type: boolean description: 'Whether MuleSoft Mozart is available to the organization.' api: type: boolean description: 'Per-API capacity included in the entitlement.' apiVisual: type: boolean description: 'Whether the visual API designer is available to the organization.' apiExample: type: boolean description: 'Whether API example projects are available to the organization.' required: - mozart - api - apiVisual - apiExample partnersProduction: type: object description: 'Whether production capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned partnersSandbox: type: object description: 'Whether sandbox capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersProduction: type: object description: 'Whether B2B Trading Partner Manager production capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersSandbox: type: object description: 'Whether B2B Trading Partner Manager sandbox capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned loadBalancer: type: object description: 'Number of dedicated load balancers available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned externalIdentity: type: boolean description: 'Whether the user belongs to an external identity provider.' autoscaling: type: boolean description: 'Whether deployment autoscaling is available to the organization.' armAlerts: type: boolean description: 'Whether Anypoint Runtime Manager alerts are available to the organization.' apis: type: object description: 'Per-API limits or counters defined for the entitlement.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiCatalog: type: object description: 'Whether the API catalog is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiMonitoring: type: object description: 'Whether API monitoring is available to the organization.' properties: schedules: type: integer description: 'Whether scheduled flows are available to the organization.' required: - schedules apiCommunityManager: type: object description: 'Whether Anypoint API Community Manager is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiExperienceHub: type: object description: 'Whether Anypoint API Experience Hub is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled monitoringCenter: type: object description: 'Whether Anypoint Monitoring Center is available to the organization.' properties: productSKU: type: integer description: 'The product SKU that identifies the entitlement.' rawStorageOverrideGB: type: integer description: 'Override for the raw storage allowance, in GB.' dataRegion: type: string description: 'The cloud region where data for this organization is stored.' productionUnits: type: integer description: 'Number of production units included in the entitlement.' preProductionUnits: type: integer description: 'Number of pre-production units included in the entitlement.' storageBase: type: integer description: 'Base storage allowance included with the entitlement, in GB.' storageAddOn: type: integer description: 'Additional storage capacity provisioned on top of the base allowance, in GB.' required: - productSKU - rawStorageOverrideGB - dataRegion - productionUnits - preProductionUnits - storageBase - storageAddOn apiQuery: type: object description: 'Whether API Query is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' productSKU: type: integer description: 'The product SKU that identifies the entitlement.' required: - enabled - productSKU apiQueryC360: type: object description: 'Whether API Query for Customer 360 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled rpa: type: object description: 'Whether MuleSoft RPA is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' active: type: boolean description: 'Whether the feature or resource is currently active.' composerVersion: type: string description: 'The version of MuleSoft Composer available to the organization.' required: - enabled - active - composerVersion idp: type: object description: 'Whether the organization can configure its own identity provider.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled AutomationCreditsDW: type: object description: 'Number of automation credits available to the organization in Data Warehouse units.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned apiGovernance: type: object description: 'Whether Anypoint API Governance is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' apisPerMonth: type: integer description: 'Number of APIs the organization is allowed to manage per month.' required: - enabled - apisPerMonth apiGovernanceDomain: type: object description: 'Whether the API Governance domain feature is available to the organization.' properties: domain: type: string description: 'The domain name associated with the organization.' required: - domain crowd: type: object description: 'Whether the Crowd developer experience is available to the organization.' properties: hideApiManagerDesigner: type: boolean description: 'Whether the legacy API Manager designer is hidden from the organization.' hideFormerApiPlatform: type: boolean description: 'Whether the former API Platform UI is hidden from the organization.' environments: type: boolean description: 'The environments configured for the organization.' required: - hideApiManagerDesigner - hideFormerApiPlatform - environments cam: type: object description: 'Whether Anypoint Connectivity Access Management (CAM) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled exchange2: type: object description: 'Whether Anypoint Exchange 2 features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' assetUsageAndEngagement: type: object description: 'Whether asset usage and engagement metrics are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - enabled - assetUsageAndEngagement crowdSelfServiceMigration: type: object description: 'Whether self-service migration to Crowd is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled kpiDashboard: type: object description: 'Whether the KPI dashboard is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled pcf: type: boolean description: 'Whether the Pivotal Cloud Foundry integration is available to the organization.' appViz: type: boolean description: 'Whether Anypoint Application Visualization is available to the organization.' workerClouds: type: object description: 'Whether MuleSoft worker clouds are available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned runtimeFabric: type: boolean description: 'Whether Anypoint Runtime Fabric is available to the organization.' runtimeFabricCloud: type: object description: 'Whether Anypoint Runtime Fabric (Cloud) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled serviceMesh: type: object description: 'Whether Anypoint Service Mesh is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled flexGateway: type: object description: 'Whether Anypoint Omni Gateway is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled managedGatewaySmall: type: object description: 'Number of small managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned managedGatewayLarge: type: object description: 'Number of large managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned rtfManagedGateway: type: object description: 'Number of Runtime Fabric managed gateways available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled composer: type: object description: 'Whether MuleSoft Composer is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' tasksPerMonth: type: integer description: 'Number of tasks the organization is allowed to run per month.' maxConnectors: type: integer description: 'Maximum number of connectors the organization is allowed to use.' unlimitedConnectors: type: boolean description: 'Whether the entitlement allows the use of an unlimited number of connectors.' isHyperAutomation: type: boolean description: 'Whether the entitlement applies to MuleSoft Hyperautomation.' required: - enabled - tasksPerMonth - maxConnectors - unlimitedConnectors - isHyperAutomation muleDxWebIde: type: object description: 'Whether the Mule DX web IDE is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxGenAI: type: object description: 'Whether Mule DX generative AI features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxEDA: type: object description: 'Whether Mule DX event-driven architecture features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled usageBasedPricing: type: object description: 'Whether usage-based pricing applies to the organization.' properties: muleRuntimeIntegration: type: object description: 'Whether Mule Runtime integration features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' flows: type: integer description: 'Flow-related limits associated with the entitlement.' messages: type: integer description: 'Per-message limits or counters defined for the entitlement.' throughput: type: integer description: 'Throughput limits defined for the entitlement.' required: - enabled - flows - messages - throughput required: - muleRuntimeIntegration usageBasedPricingLimits: type: object description: 'Limits that apply to the organization under usage-based pricing.' properties: cpu: type: object description: 'CPU resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra memory: type: object description: 'Memory resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra required: - cpu - memory highAvailability: type: object description: 'Whether the entitlement allows high-availability deployments.' properties: clustering: type: boolean description: 'Whether the entitlement allows clustered deployments.' required: - clustering cloudhub1: type: object description: 'Whether CloudHub 1.0 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled telemetryExporter: type: object description: 'Whether the telemetry exporter is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - createSubOrgs - createEnvironments - hybrid - hybridInsight - hybridAutoDiscoverProperties - globalDeployment - vCoresProduction - vCoresSandbox - vCoresDesign - staticIps - vpcs - vpns - networkConnections - workerLoggingOverride - messaging - mqMessages - mqRequests - mqAdvancedFeatures - objectStoreRequestUnits - objectStoreKeys - gateways - designCenter - partnersProduction - partnersSandbox - tradingPartnersProduction - tradingPartnersSandbox - loadBalancer - externalIdentity - autoscaling - armAlerts - apis - apiCatalog - apiMonitoring - apiCommunityManager - apiExperienceHub - monitoringCenter - apiQuery - apiQueryC360 - rpa - idp - AutomationCreditsDW - apiGovernance - apiGovernanceDomain - crowd - cam - exchange2 - crowdSelfServiceMigration - kpiDashboard - pcf - appViz - workerClouds - runtimeFabric - runtimeFabricCloud - serviceMesh - flexGateway - managedGatewaySmall - managedGatewayLarge - rtfManagedGateway - composer - muleDxWebIde - muleDxGenAI - muleDxEDA - usageBasedPricing - usageBasedPricingLimits - highAvailability - cloudhub1 - telemetryExporter isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: object tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration required: - name - id - createdAt - ownerId - updatedAt - clientId - domain - idprovider_id - properties - entitlements - isFederated - isRoot - isMaster - parentOrganizationIds - subOrganizationIds - tenantOrganizationIds - subscription isApiConsumer: type: boolean description: 'Whether the user has been granted API consumer access.' required: - id - username - firstName - lastName - email - email_verified_at - enabled - idprovider_id - type - createdAt - updatedAt - lastLogin - organizationId - organization - isApiConsumer total: type: integer description: 'The total number of items available across all pages.' required: - data - total '404': description: Organization does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List organization users operationId: listUsers post: description: Create a single user under the organization parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: content: application/json: example: username: juanferrerorocher firstName: Juan lastName: Ferrer email: jferrer@mulesoft.com phoneNumber: 111-111-1111 password: my_very_secure_password schema: type: object description: 'Request payload for createUsers.' properties: username: type: string description: 'The username used to authenticate the user.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email phoneNumber: type: string description: 'The user''s phone number.' password: type: string description: 'The user''s password. Write-only.' required: - username - firstName - lastName - email - phoneNumber - password x-amf-mediaType: application/json description: Request payload for create users. responses: '201': description: Success '404': description: Organization does not exist '409': description: Username already exists '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create an organization user operationId: createUsers put: description: Update a group of users parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/Generated12' responses: '204': description: Success '400': description: Invalid data in body or not all users are part of the specified org '404': description: Organization does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update organization users operationId: updateUsers delete: description: Deletes a group of users parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' requestBody: $ref: '#/components/requestBodies/Generated10' responses: '204': description: Success '404': description: Organization does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete organization users operationId: deleteUsers /organizations/{organizationId}/users/{userId}: description: A single user that belongs to the organization get: description: Returns a single user parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: id: 5197cdf3-36c9-4bcb-8840-5779e961c746 createdAt: 2015-01-29 00:00:53.315000+00:00 updatedAt: 2015-01-29 00:00:55.163000+00:00 lastLogin: 2015-01-29 00:11:55.163000+00:00 previousLastLogin: 2015-01-28 00:11:55.163000+00:00 firstName: Organization lastName: Owner ipAllowlistExcluded: false email: core_services@mulesoft.com email_verified_at: 2015-01-29 00: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-03 00:20:06.125000+00:00 ownerId: 57e281b5-ec5b-4701-80a0-92a936a68da3 updatedAt: 2015-02-03 00: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-27 20:56:02.125000+00:00 properties: {} schema: type: object description: 'Response payload for getUsers.' properties: id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' previousLastLogin: type: string description: 'The date and time of the user''s previous successful login, in ISO 8601 format.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' ipAllowlistExcluded: type: boolean description: 'Whether the resource is excluded from organization-level IP allowlist enforcement.' email: type: string description: 'The user''s email address.' format: email email_verified_at: type: string description: 'The date and time when the user''s email address was verified, in ISO 8601 format.' phoneNumber: type: string description: 'The user''s phone number.' username: type: string description: 'The username used to authenticate the user.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' deleted: type: boolean description: 'Whether the resource has been marked as deleted.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' organization: type: object description: 'The organization that owns the resource.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' properties: type: object description: 'Additional properties associated with the resource.' properties: defaultAccessManagementUi: type: string description: 'The Access Management UI variant the organization defaults to.' required: - defaultAccessManagementUi entitlements: type: object description: 'The features and capabilities the organization is entitled to use.' properties: createSubOrgs: type: boolean description: 'Whether the organization is allowed to create sub-organizations.' createEnvironments: type: boolean description: 'Whether the organization is allowed to create environments.' hybrid: type: object description: 'Whether hybrid deployments are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled hybridInsight: type: boolean description: 'Whether Hybrid Insight is available to the organization.' hybridAutoDiscoverProperties: type: boolean description: 'Whether hybrid runtimes can auto-discover platform properties.' globalDeployment: type: boolean description: 'Whether the entitlement allows global deployment of MuleSoft applications.' vCoresProduction: type: object description: 'Number of production vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresSandbox: type: object description: 'Number of sandbox vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresDesign: type: object description: 'Number of design-time vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned staticIps: type: object description: 'Number of static IPs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpcs: type: object description: 'Number of Anypoint VPCs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpns: type: object description: 'Number of VPN connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned networkConnections: type: object description: 'Number of network connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned workerLoggingOverride: type: object description: 'Whether the organization can override worker logging configuration.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled messaging: type: object description: 'Whether Anypoint MQ is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned mqMessages: type: object description: 'Number of Anypoint MQ messages included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqRequests: type: object description: 'Number of Anypoint MQ requests included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqAdvancedFeatures: type: object description: 'Whether Anypoint MQ advanced features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled objectStoreRequestUnits: type: object description: 'Number of Object Store request units included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn objectStoreKeys: type: object description: 'Number of Object Store keys included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn gateways: type: object description: 'Number of API gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned designCenter: type: object description: 'Whether Anypoint Design Center is available to the organization.' properties: mozart: type: boolean description: 'Whether MuleSoft Mozart is available to the organization.' api: type: boolean description: 'Per-API capacity included in the entitlement.' apiVisual: type: boolean description: 'Whether the visual API designer is available to the organization.' apiExample: type: boolean description: 'Whether API example projects are available to the organization.' required: - mozart - api - apiVisual - apiExample partnersProduction: type: object description: 'Whether production capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned partnersSandbox: type: object description: 'Whether sandbox capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersProduction: type: object description: 'Whether B2B Trading Partner Manager production capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersSandbox: type: object description: 'Whether B2B Trading Partner Manager sandbox capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned loadBalancer: type: object description: 'Number of dedicated load balancers available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned externalIdentity: type: boolean description: 'Whether the user belongs to an external identity provider.' autoscaling: type: boolean description: 'Whether deployment autoscaling is available to the organization.' armAlerts: type: boolean description: 'Whether Anypoint Runtime Manager alerts are available to the organization.' apis: type: object description: 'Per-API limits or counters defined for the entitlement.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiCatalog: type: object description: 'Whether the API catalog is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiMonitoring: type: object description: 'Whether API monitoring is available to the organization.' properties: schedules: type: integer description: 'Whether scheduled flows are available to the organization.' required: - schedules apiCommunityManager: type: object description: 'Whether Anypoint API Community Manager is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiExperienceHub: type: object description: 'Whether Anypoint API Experience Hub is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled monitoringCenter: type: object description: 'Whether Anypoint Monitoring Center is available to the organization.' properties: productSKU: type: integer description: 'The product SKU that identifies the entitlement.' rawStorageOverrideGB: type: integer description: 'Override for the raw storage allowance, in GB.' dataRegion: type: string description: 'The cloud region where data for this organization is stored.' productionUnits: type: integer description: 'Number of production units included in the entitlement.' preProductionUnits: type: integer description: 'Number of pre-production units included in the entitlement.' storageBase: type: integer description: 'Base storage allowance included with the entitlement, in GB.' storageAddOn: type: integer description: 'Additional storage capacity provisioned on top of the base allowance, in GB.' required: - productSKU - rawStorageOverrideGB - dataRegion - productionUnits - preProductionUnits - storageBase - storageAddOn apiQuery: type: object description: 'Whether API Query is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' productSKU: type: integer description: 'The product SKU that identifies the entitlement.' required: - enabled - productSKU apiQueryC360: type: object description: 'Whether API Query for Customer 360 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled rpa: type: object description: 'Whether MuleSoft RPA is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' active: type: boolean description: 'Whether the feature or resource is currently active.' composerVersion: type: string description: 'The version of MuleSoft Composer available to the organization.' required: - enabled - active - composerVersion idp: type: object description: 'Whether the organization can configure its own identity provider.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled AutomationCreditsDW: type: object description: 'Number of automation credits available to the organization in Data Warehouse units.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned apiGovernance: type: object description: 'Whether Anypoint API Governance is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' apisPerMonth: type: integer description: 'Number of APIs the organization is allowed to manage per month.' required: - enabled - apisPerMonth apiGovernanceDomain: type: object description: 'Whether the API Governance domain feature is available to the organization.' properties: domain: type: string description: 'The domain name associated with the organization.' required: - domain crowd: type: object description: 'Whether the Crowd developer experience is available to the organization.' properties: hideApiManagerDesigner: type: boolean description: 'Whether the legacy API Manager designer is hidden from the organization.' hideFormerApiPlatform: type: boolean description: 'Whether the former API Platform UI is hidden from the organization.' environments: type: boolean description: 'The environments configured for the organization.' required: - hideApiManagerDesigner - hideFormerApiPlatform - environments cam: type: object description: 'Whether Anypoint Connectivity Access Management (CAM) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled exchange2: type: object description: 'Whether Anypoint Exchange 2 features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' assetUsageAndEngagement: type: object description: 'Whether asset usage and engagement metrics are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - enabled - assetUsageAndEngagement crowdSelfServiceMigration: type: object description: 'Whether self-service migration to Crowd is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled kpiDashboard: type: object description: 'Whether the KPI dashboard is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled pcf: type: boolean description: 'Whether the Pivotal Cloud Foundry integration is available to the organization.' appViz: type: boolean description: 'Whether Anypoint Application Visualization is available to the organization.' workerClouds: type: object description: 'Whether MuleSoft worker clouds are available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned runtimeFabric: type: boolean description: 'Whether Anypoint Runtime Fabric is available to the organization.' runtimeFabricCloud: type: object description: 'Whether Anypoint Runtime Fabric (Cloud) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled serviceMesh: type: object description: 'Whether Anypoint Service Mesh is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled flexGateway: type: object description: 'Whether Anypoint Omni Gateway is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled managedGatewaySmall: type: object description: 'Number of small managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned managedGatewayLarge: type: object description: 'Number of large managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned rtfManagedGateway: type: object description: 'Number of Runtime Fabric managed gateways available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled composer: type: object description: 'Whether MuleSoft Composer is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' tasksPerMonth: type: integer description: 'Number of tasks the organization is allowed to run per month.' maxConnectors: type: integer description: 'Maximum number of connectors the organization is allowed to use.' unlimitedConnectors: type: boolean description: 'Whether the entitlement allows the use of an unlimited number of connectors.' isHyperAutomation: type: boolean description: 'Whether the entitlement applies to MuleSoft Hyperautomation.' required: - enabled - tasksPerMonth - maxConnectors - unlimitedConnectors - isHyperAutomation muleDxWebIde: type: object description: 'Whether the Mule DX web IDE is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxGenAI: type: object description: 'Whether Mule DX generative AI features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxEDA: type: object description: 'Whether Mule DX event-driven architecture features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled usageBasedPricing: type: object description: 'Whether usage-based pricing applies to the organization.' properties: muleRuntimeIntegration: type: object description: 'Whether Mule Runtime integration features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' flows: type: integer description: 'Flow-related limits associated with the entitlement.' messages: type: integer description: 'Per-message limits or counters defined for the entitlement.' throughput: type: integer description: 'Throughput limits defined for the entitlement.' required: - enabled - flows - messages - throughput required: - muleRuntimeIntegration usageBasedPricingLimits: type: object description: 'Limits that apply to the organization under usage-based pricing.' properties: cpu: type: object description: 'CPU resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra memory: type: object description: 'Memory resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra required: - cpu - memory highAvailability: type: object description: 'Whether the entitlement allows high-availability deployments.' properties: clustering: type: boolean description: 'Whether the entitlement allows clustered deployments.' required: - clustering cloudhub1: type: object description: 'Whether CloudHub 1.0 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled telemetryExporter: type: object description: 'Whether the telemetry exporter is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - createSubOrgs - createEnvironments - hybrid - hybridInsight - hybridAutoDiscoverProperties - globalDeployment - vCoresProduction - vCoresSandbox - vCoresDesign - staticIps - vpcs - vpns - networkConnections - workerLoggingOverride - messaging - mqMessages - mqRequests - mqAdvancedFeatures - objectStoreRequestUnits - objectStoreKeys - gateways - designCenter - partnersProduction - partnersSandbox - tradingPartnersProduction - tradingPartnersSandbox - loadBalancer - externalIdentity - autoscaling - armAlerts - apis - apiCatalog - apiMonitoring - apiCommunityManager - apiExperienceHub - monitoringCenter - apiQuery - apiQueryC360 - rpa - idp - AutomationCreditsDW - apiGovernance - apiGovernanceDomain - crowd - cam - exchange2 - crowdSelfServiceMigration - kpiDashboard - pcf - appViz - workerClouds - runtimeFabric - runtimeFabricCloud - serviceMesh - flexGateway - managedGatewaySmall - managedGatewayLarge - rtfManagedGateway - composer - muleDxWebIde - muleDxGenAI - muleDxEDA - usageBasedPricing - usageBasedPricingLimits - highAvailability - cloudhub1 - telemetryExporter isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: object tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration required: - name - id - createdAt - ownerId - updatedAt - clientId - domain - idprovider_id - properties - entitlements - isFederated - isRoot - isMaster - parentOrganizationIds - subOrganizationIds - tenantOrganizationIds - subscription properties: type: object description: 'Additional properties associated with the resource.' properties: {} required: - id - createdAt - updatedAt - lastLogin - previousLastLogin - firstName - lastName - ipAllowlistExcluded - email - email_verified_at - phoneNumber - username - enabled - deleted - idprovider_id - organization - properties '404': description: User does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get an organization user operationId: getUsers put: description: Updates a single user. Modifying email may require reauthentication. parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' requestBody: $ref: '#/components/requestBodies/Generated4' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: id: 5197cdf3-36c9-4bcb-8840-5779e961c746 createdAt: 2015-01-29 00:00:53.315000+00:00 updatedAt: 2015-01-29 00:00:55.163000+00:00 lastLogin: 2015-01-29 00:11:55.163000+00:00 previousLastLogin: 2015-01-28 00:11:55.163000+00:00 firstName: Organization lastName: Owner ipAllowlistExcluded: false email: core_services@mulesoft.com email_verified_at: 2015-01-29 00: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-03 00:20:06.125000+00:00 ownerId: 57e281b5-ec5b-4701-80a0-92a936a68da3 updatedAt: 2015-02-03 00: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-27 20:56:02.125000+00:00 properties: {} schema: type: object description: 'Response payload for updateOrganizationUser.' properties: id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' previousLastLogin: type: string description: 'The date and time of the user''s previous successful login, in ISO 8601 format.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' ipAllowlistExcluded: type: boolean description: 'Whether the resource is excluded from organization-level IP allowlist enforcement.' email: type: string description: 'The user''s email address.' format: email email_verified_at: type: string description: 'The date and time when the user''s email address was verified, in ISO 8601 format.' phoneNumber: type: string description: 'The user''s phone number.' username: type: string description: 'The username used to authenticate the user.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' deleted: type: boolean description: 'Whether the resource has been marked as deleted.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' organization: type: object description: 'The organization that owns the resource.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' properties: type: object description: 'Additional properties associated with the resource.' properties: defaultAccessManagementUi: type: string description: 'The Access Management UI variant the organization defaults to.' required: - defaultAccessManagementUi entitlements: type: object description: 'The features and capabilities the organization is entitled to use.' properties: createSubOrgs: type: boolean description: 'Whether the organization is allowed to create sub-organizations.' createEnvironments: type: boolean description: 'Whether the organization is allowed to create environments.' hybrid: type: object description: 'Whether hybrid deployments are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled hybridInsight: type: boolean description: 'Whether Hybrid Insight is available to the organization.' hybridAutoDiscoverProperties: type: boolean description: 'Whether hybrid runtimes can auto-discover platform properties.' globalDeployment: type: boolean description: 'Whether the entitlement allows global deployment of MuleSoft applications.' vCoresProduction: type: object description: 'Number of production vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresSandbox: type: object description: 'Number of sandbox vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresDesign: type: object description: 'Number of design-time vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned staticIps: type: object description: 'Number of static IPs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpcs: type: object description: 'Number of Anypoint VPCs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpns: type: object description: 'Number of VPN connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned networkConnections: type: object description: 'Number of network connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned workerLoggingOverride: type: object description: 'Whether the organization can override worker logging configuration.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled messaging: type: object description: 'Whether Anypoint MQ is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned mqMessages: type: object description: 'Number of Anypoint MQ messages included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqRequests: type: object description: 'Number of Anypoint MQ requests included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqAdvancedFeatures: type: object description: 'Whether Anypoint MQ advanced features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled objectStoreRequestUnits: type: object description: 'Number of Object Store request units included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn objectStoreKeys: type: object description: 'Number of Object Store keys included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn gateways: type: object description: 'Number of API gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned designCenter: type: object description: 'Whether Anypoint Design Center is available to the organization.' properties: mozart: type: boolean description: 'Whether MuleSoft Mozart is available to the organization.' api: type: boolean description: 'Per-API capacity included in the entitlement.' apiVisual: type: boolean description: 'Whether the visual API designer is available to the organization.' apiExample: type: boolean description: 'Whether API example projects are available to the organization.' required: - mozart - api - apiVisual - apiExample partnersProduction: type: object description: 'Whether production capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned partnersSandbox: type: object description: 'Whether sandbox capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersProduction: type: object description: 'Whether B2B Trading Partner Manager production capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersSandbox: type: object description: 'Whether B2B Trading Partner Manager sandbox capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned loadBalancer: type: object description: 'Number of dedicated load balancers available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned externalIdentity: type: boolean description: 'Whether the user belongs to an external identity provider.' autoscaling: type: boolean description: 'Whether deployment autoscaling is available to the organization.' armAlerts: type: boolean description: 'Whether Anypoint Runtime Manager alerts are available to the organization.' apis: type: object description: 'Per-API limits or counters defined for the entitlement.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiCatalog: type: object description: 'Whether the API catalog is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiMonitoring: type: object description: 'Whether API monitoring is available to the organization.' properties: schedules: type: integer description: 'Whether scheduled flows are available to the organization.' required: - schedules apiCommunityManager: type: object description: 'Whether Anypoint API Community Manager is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiExperienceHub: type: object description: 'Whether Anypoint API Experience Hub is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled monitoringCenter: type: object description: 'Whether Anypoint Monitoring Center is available to the organization.' properties: productSKU: type: integer description: 'The product SKU that identifies the entitlement.' rawStorageOverrideGB: type: integer description: 'Override for the raw storage allowance, in GB.' dataRegion: type: string description: 'The cloud region where data for this organization is stored.' productionUnits: type: integer description: 'Number of production units included in the entitlement.' preProductionUnits: type: integer description: 'Number of pre-production units included in the entitlement.' storageBase: type: integer description: 'Base storage allowance included with the entitlement, in GB.' storageAddOn: type: integer description: 'Additional storage capacity provisioned on top of the base allowance, in GB.' required: - productSKU - rawStorageOverrideGB - dataRegion - productionUnits - preProductionUnits - storageBase - storageAddOn apiQuery: type: object description: 'Whether API Query is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' productSKU: type: integer description: 'The product SKU that identifies the entitlement.' required: - enabled - productSKU apiQueryC360: type: object description: 'Whether API Query for Customer 360 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled rpa: type: object description: 'Whether MuleSoft RPA is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' active: type: boolean description: 'Whether the feature or resource is currently active.' composerVersion: type: string description: 'The version of MuleSoft Composer available to the organization.' required: - enabled - active - composerVersion idp: type: object description: 'Whether the organization can configure its own identity provider.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled AutomationCreditsDW: type: object description: 'Number of automation credits available to the organization in Data Warehouse units.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned apiGovernance: type: object description: 'Whether Anypoint API Governance is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' apisPerMonth: type: integer description: 'Number of APIs the organization is allowed to manage per month.' required: - enabled - apisPerMonth apiGovernanceDomain: type: object description: 'Whether the API Governance domain feature is available to the organization.' properties: domain: type: string description: 'The domain name associated with the organization.' required: - domain crowd: type: object description: 'Whether the Crowd developer experience is available to the organization.' properties: hideApiManagerDesigner: type: boolean description: 'Whether the legacy API Manager designer is hidden from the organization.' hideFormerApiPlatform: type: boolean description: 'Whether the former API Platform UI is hidden from the organization.' environments: type: boolean description: 'The environments configured for the organization.' required: - hideApiManagerDesigner - hideFormerApiPlatform - environments cam: type: object description: 'Whether Anypoint Connectivity Access Management (CAM) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled exchange2: type: object description: 'Whether Anypoint Exchange 2 features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' assetUsageAndEngagement: type: object description: 'Whether asset usage and engagement metrics are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - enabled - assetUsageAndEngagement crowdSelfServiceMigration: type: object description: 'Whether self-service migration to Crowd is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled kpiDashboard: type: object description: 'Whether the KPI dashboard is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled pcf: type: boolean description: 'Whether the Pivotal Cloud Foundry integration is available to the organization.' appViz: type: boolean description: 'Whether Anypoint Application Visualization is available to the organization.' workerClouds: type: object description: 'Whether MuleSoft worker clouds are available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned runtimeFabric: type: boolean description: 'Whether Anypoint Runtime Fabric is available to the organization.' runtimeFabricCloud: type: object description: 'Whether Anypoint Runtime Fabric (Cloud) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled serviceMesh: type: object description: 'Whether Anypoint Service Mesh is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled flexGateway: type: object description: 'Whether Anypoint Omni Gateway is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled managedGatewaySmall: type: object description: 'Number of small managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned managedGatewayLarge: type: object description: 'Number of large managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned rtfManagedGateway: type: object description: 'Number of Runtime Fabric managed gateways available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled composer: type: object description: 'Whether MuleSoft Composer is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' tasksPerMonth: type: integer description: 'Number of tasks the organization is allowed to run per month.' maxConnectors: type: integer description: 'Maximum number of connectors the organization is allowed to use.' unlimitedConnectors: type: boolean description: 'Whether the entitlement allows the use of an unlimited number of connectors.' isHyperAutomation: type: boolean description: 'Whether the entitlement applies to MuleSoft Hyperautomation.' required: - enabled - tasksPerMonth - maxConnectors - unlimitedConnectors - isHyperAutomation muleDxWebIde: type: object description: 'Whether the Mule DX web IDE is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxGenAI: type: object description: 'Whether Mule DX generative AI features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxEDA: type: object description: 'Whether Mule DX event-driven architecture features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled usageBasedPricing: type: object description: 'Whether usage-based pricing applies to the organization.' properties: muleRuntimeIntegration: type: object description: 'Whether Mule Runtime integration features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' flows: type: integer description: 'Flow-related limits associated with the entitlement.' messages: type: integer description: 'Per-message limits or counters defined for the entitlement.' throughput: type: integer description: 'Throughput limits defined for the entitlement.' required: - enabled - flows - messages - throughput required: - muleRuntimeIntegration usageBasedPricingLimits: type: object description: 'Limits that apply to the organization under usage-based pricing.' properties: cpu: type: object description: 'CPU resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra memory: type: object description: 'Memory resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra required: - cpu - memory highAvailability: type: object description: 'Whether the entitlement allows high-availability deployments.' properties: clustering: type: boolean description: 'Whether the entitlement allows clustered deployments.' required: - clustering cloudhub1: type: object description: 'Whether CloudHub 1.0 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled telemetryExporter: type: object description: 'Whether the telemetry exporter is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - createSubOrgs - createEnvironments - hybrid - hybridInsight - hybridAutoDiscoverProperties - globalDeployment - vCoresProduction - vCoresSandbox - vCoresDesign - staticIps - vpcs - vpns - networkConnections - workerLoggingOverride - messaging - mqMessages - mqRequests - mqAdvancedFeatures - objectStoreRequestUnits - objectStoreKeys - gateways - designCenter - partnersProduction - partnersSandbox - tradingPartnersProduction - tradingPartnersSandbox - loadBalancer - externalIdentity - autoscaling - armAlerts - apis - apiCatalog - apiMonitoring - apiCommunityManager - apiExperienceHub - monitoringCenter - apiQuery - apiQueryC360 - rpa - idp - AutomationCreditsDW - apiGovernance - apiGovernanceDomain - crowd - cam - exchange2 - crowdSelfServiceMigration - kpiDashboard - pcf - appViz - workerClouds - runtimeFabric - runtimeFabricCloud - serviceMesh - flexGateway - managedGatewaySmall - managedGatewayLarge - rtfManagedGateway - composer - muleDxWebIde - muleDxGenAI - muleDxEDA - usageBasedPricing - usageBasedPricingLimits - highAvailability - cloudhub1 - telemetryExporter isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: object tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration required: - name - id - createdAt - ownerId - updatedAt - clientId - domain - idprovider_id - properties - entitlements - isFederated - isRoot - isMaster - parentOrganizationIds - subOrganizationIds - tenantOrganizationIds - subscription properties: type: object description: 'Additional properties associated with the resource.' properties: {} required: - id - createdAt - updatedAt - lastLogin - previousLastLogin - firstName - lastName - ipAllowlistExcluded - email - email_verified_at - phoneNumber - username - enabled - deleted - idprovider_id - organization - properties '302': description: Reauthentication required. '400': description: Invalid data in body '403': description: Reauthentication required. See location link x-amf-mediaType: application/json content: application/json: example: error: You must reauthenticate location: /login/?reauthenticate=true schema: type: object description: 'Response payload for updateOrganizationUser.' properties: error: type: string description: 'Error information returned with the response.' location: type: string description: 'The geographic location associated with the resource.' required: - error - location '404': description: User does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update an organization user operationId: updateOrganizationUser delete: description: Deletes a user parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' responses: '200': description: Success '404': description: User does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete an organization user operationId: deleteOrganizationUser /organizations/{organizationId}/users/{userId}/manage_verifiers: get: description: 'Returns information about how to initiate a redirect to the VaaS Verifier Management UI. ' parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' responses: '200': description: Success '405': description: MethodNotAllowed - user is exempt from MFA requirements security: - bearerAuth: [] - clientAuth: [] summary: Get user verifier management redirect operationId: listUsersManageVerifiers /organizations/{organizationId}/users/{userId}/properties: description: A user's properties. put: parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' requestBody: $ref: '#/components/requestBodies/Generated13' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: cs_auth: activeOrganizationId: f0c9b011-980e-4928-9430-e60e3a97c043 schema: type: object description: 'Response payload for updateUsersProperties.' properties: cs_auth: type: object description: 'Configuration for Anypoint Platform authentication settings.' properties: activeOrganizationId: type: string description: 'The unique identifier of the organization currently active in the user''s session.' required: - activeOrganizationId required: - cs_auth '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update user directory properties operationId: updateUsersProperties description: Updates an existing users properties in the platform user directory. /organizations/{organizationId}/users/{userId}/rolegroups: description: Role groups assigned to the user get: description: Returns the role groups assigned to the user parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for listUsersRolegroups.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: role_group_id: type: string description: 'The unique identifier of the role group (legacy term for team).' name: type: string description: 'The display name of the resource.' description: type: string description: 'A human-readable description of the resource.' context_params: type: object description: 'Additional parameters that scope the operation to a specific organization or environment.' properties: {} user_role_group_id: type: string description: 'The unique identifier of the role-group assignment for the user.' required: - role_group_id - name - description - context_params - user_role_group_id total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List user role groups operationId: listUsersRolegroups /organizations/{organizationId}/users/{userId}/rolegroups/{roleGroupId}: description: A single role group assigned to the user post: description: Assigns the role group to the user parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' - $ref: '#/components/parameters/XOrigin_userRolegroupId_Path' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Assign a role group to a user operationId: createUsersRolegroups delete: description: Unassigns the role group from the user parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' - $ref: '#/components/parameters/XOrigin_userRolegroupId_Path' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Unassign a role group from a user operationId: deleteUsersRolegroups /organizations/{organizationId}/users/{userId}/roles: description: Roles/permissions assigned to the user get: description: '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. ' parameters: - name: role_groups description: include permissions assigned via Business Group Role (a.k.a Role Group) membership required: false in: query schema: type: boolean - name: teams description: include permissions assigned via Team membership required: false in: query schema: type: boolean - name: namespace description: return only role/permission assignments where a role contains a permission that is part of the given namespace required: false in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' x-amf-queryParameters: role_id: description: return only role/permission assignments containing one of the supplied role_ids required: false anyOf: - type: string - items: type: string namespaces: description: return only role/permission assignments where a role belongs to the given namespace required: false anyOf: - type: string - items: type: string responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for listUsersRoles.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: role_id: type: string description: 'The unique identifier of the role.' context_params: type: object description: 'Additional parameters that scope the operation to a specific organization or environment.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' required: - org name: type: string description: 'The display name of the resource.' description: type: string description: 'A human-readable description of the resource.' required: - role_id - context_params - name - description total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List user roles operationId: listUsersRoles post: description: Bulk assign roles to the user parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' requestBody: content: application/json: example: d74ef94a-4292-4896-b860-b05bd7f90d6d: org: 68ef9520-24e9-4cf2-b2f5-620025690913 schema: type: object description: 'Request payload for createUsersRoles.' properties: d74ef94a-4292-4896-b860-b05bd7f90d6d: type: object description: 'Per-resource entry keyed by identifier.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' required: - org required: - d74ef94a-4292-4896-b860-b05bd7f90d6d x-amf-mediaType: application/json description: Request payload for create users roles. responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Bulk assign roles to a user operationId: createUsersRoles /organizations/{organizationId}/users/{userId}/roles/{roleId}: post: description: Assign a role to the user parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' - $ref: '#/components/parameters/XOrigin_userRoleId_Path' requestBody: $ref: '#/components/requestBodies/Generated2' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Assign a role to a user operationId: addRoleToOrganizationUser delete: description: Unassign a role from the user parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' - $ref: '#/components/parameters/XOrigin_userRoleId_Path' requestBody: $ref: '#/components/requestBodies/Generated2' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Unassign a role from a user operationId: deleteUsersRoles /organizations/{organizationId}/users/{userId}/teams: get: description: Returns a list of teams the user is a member of parameters: - name: ancestor_team_id description: team_id that must appear in the team's ancestor_team_ids. in: query style: form explode: false schema: type: array items: type: string - name: membership_type description: return only teams where the user is this type of member required: false in: query style: form explode: false schema: type: array items: type: string - name: parent_team_id description: team_id of the immediate parent of the team to return. in: query style: form explode: false schema: type: array items: type: string - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: ascending description: Whether to sort ascending or descending required: true in: query schema: type: boolean default: true - name: team_type description: return only teams that are of this type required: false in: query style: form explode: false schema: type: array items: type: string - name: sort description: The field to sort on. required: false in: query schema: type: string enum: - team_name - created_at - team_id default: team_name - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - name: search description: A search string to use for case-insensitive partial matches on team name required: false in: query schema: type: string - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/TeamIsMemberOf' total: type: number example: 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-15 09:36:07.123000+00:00 updated_at: 2019-07-15 09:36:07.123000+00:00 membership_type: maintainer is_assigned_via_external_groups: false total: 1 '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List user teams operationId: listUsersTeams /organizations/{organizationId}/users/{userId}/verifiers: delete: description: Revokes all mfa verifiers associated with the user parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' responses: '204': description: Success '405': description: MethodNotAllowed - user is exempt from MFA requirements security: - bearerAuth: [] - clientAuth: [] summary: Revoke user MFA verifiers operationId: deleteUsersVerifiers /organizations/{organizationId}/users/{userId}/identityProviderProfiles: get: description: Returns the list of the identity provider profiles of the user parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' responses: '200': description: '' x-amf-mediaType: application/json content: application/json: example: - 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-19 23:22:36.212000+00:00 updatedAt: 2023-01-19 23:22:36.212000+00:00 isFederated: true lastLoginAt: 2023-04-19 23:22:36.212000+00:00 schema: type: array description: 'Response payload for listUsersIdentityProviderProfiles.' items: type: object description: 'Response payload for listUsersIdentityProviderProfiles.' properties: idpUserId: type: string description: 'The identifier of the user as recorded in the external identity provider.' format: email idpUserName: type: 'null' description: 'The username of the user as recorded in the external identity provider.' userId: type: string description: 'The unique identifier of the user.' providerId: type: string description: 'The unique identifier of the identity provider.' loginProfileData: type: string description: 'Profile data captured during the most recent login.' format: email createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' lastLoginAt: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' required: - idpUserId - idpUserName - userId - providerId - loginProfileData - createdAt - updatedAt - isFederated - lastLoginAt '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List user identity provider profiles operationId: listUsersIdentityProviderProfiles delete: description: Removes an identity provider profile from a user parameters: - $ref: '#/components/parameters/XOrigin_organizationId_Path' - $ref: '#/components/parameters/XOrigin_orgScopedUserId_Path' requestBody: content: application/json: example: idpUserId: idpUserFromOkta@gmail.com providerId: 03bf5aff-a0e2-4e1a-8377-b7e4f67750df schema: type: object description: 'Request payload for deleteUsersIdentityProviderProfiles.' properties: idpUserId: type: string description: 'The identifier of the user as recorded in the external identity provider.' format: email providerId: type: string description: 'The unique identifier of the identity provider.' required: - idpUserId - providerId x-amf-mediaType: application/json description: Request payload for delete users identity provider profiles. responses: '200': description: Success. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Remove a user identity provider profile operationId: deleteUsersIdentityProviderProfiles /profile: get: description: Returns the user bound to the provided access token responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: id: 57e281b5-ec5b-4701-80a0-92a936a68da3 createdAt: 2015-03-13 18:03:21.748000+00:00 updatedAt: 2015-03-13 18:03:28.089000+00:00 lastLogin: 2015-03-13 18:16:28.089000+00:00 previousLastLogin: 2015-03-12 18: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-13 18:03:23.869000+00:00 updatedAt: 2015-03-13 18: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-27 20: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-13 18:03:23.869000+00:00 updatedAt: 2015-03-13 18: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-27 20:56:02.125000+00:00 contributorOfOrganizations: - name: MuleSoft Inc id: f0c9b011-980e-4928-9430-e60e3a97c043 createdAt: 2015-03-13 18:03:23.869000+00:00 updatedAt: 2015-03-13 18: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-27 20: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 schema: type: object description: 'Response payload for listProfile.' properties: id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' previousLastLogin: type: string description: 'The date and time of the user''s previous successful login, in ISO 8601 format.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email phoneNumber: type: string description: 'The user''s phone number.' username: type: string description: 'The username used to authenticate the user.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' deleted: type: boolean description: 'Whether the resource has been marked as deleted.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' type: type: string description: 'The type of the resource.' organizationId: type: string description: 'The unique identifier of the organization.' organization: type: object description: 'The organization that owns the resource.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: string description: 'Identifiers of the organizations that are direct children of this organization.' tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' properties: type: object description: 'Additional properties associated with the resource.' properties: defaultAccessManagementUi: type: string description: 'The Access Management UI variant the organization defaults to.' required: - defaultAccessManagementUi entitlements: type: object description: 'The features and capabilities the organization is entitled to use.' properties: partnersProduction: type: object description: 'Whether production capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned partnersSandbox: type: object description: 'Whether sandbox capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersProduction: type: object description: 'Whether B2B Trading Partner Manager production capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersSandbox: type: object description: 'Whether B2B Trading Partner Manager sandbox capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned createSubOrgs: type: boolean description: 'Whether the organization is allowed to create sub-organizations.' createEnvironments: type: boolean description: 'Whether the organization is allowed to create environments.' hybrid: type: object description: 'Whether hybrid deployments are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled hybridInsight: type: boolean description: 'Whether Hybrid Insight is available to the organization.' hybridAutoDiscoverProperties: type: boolean description: 'Whether hybrid runtimes can auto-discover platform properties.' globalDeployment: type: boolean description: 'Whether the entitlement allows global deployment of MuleSoft applications.' vCoresProduction: type: object description: 'Number of production vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresSandbox: type: object description: 'Number of sandbox vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresDesign: type: object description: 'Number of design-time vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned staticIps: type: object description: 'Number of static IPs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpcs: type: object description: 'Number of Anypoint VPCs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpns: type: object description: 'Number of VPN connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned networkConnections: type: object description: 'Number of network connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned workerLoggingOverride: type: object description: 'Whether the organization can override worker logging configuration.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled messaging: type: object description: 'Whether Anypoint MQ is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned mqMessages: type: object description: 'Number of Anypoint MQ messages included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqRequests: type: object description: 'Number of Anypoint MQ requests included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqAdvancedFeatures: type: object description: 'Whether Anypoint MQ advanced features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled objectStoreRequestUnits: type: object description: 'Number of Object Store request units included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn objectStoreKeys: type: object description: 'Number of Object Store keys included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn gateways: type: object description: 'Number of API gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned designCenter: type: object description: 'Whether Anypoint Design Center is available to the organization.' properties: mozart: type: boolean description: 'Whether MuleSoft Mozart is available to the organization.' api: type: boolean description: 'Per-API capacity included in the entitlement.' apiVisual: type: boolean description: 'Whether the visual API designer is available to the organization.' apiExample: type: boolean description: 'Whether API example projects are available to the organization.' required: - mozart - api - apiVisual - apiExample loadBalancer: type: object description: 'Number of dedicated load balancers available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned externalIdentity: type: boolean description: 'Whether the user belongs to an external identity provider.' autoscaling: type: boolean description: 'Whether deployment autoscaling is available to the organization.' armAlerts: type: boolean description: 'Whether Anypoint Runtime Manager alerts are available to the organization.' apis: type: object description: 'Per-API limits or counters defined for the entitlement.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiCatalog: type: object description: 'Whether the API catalog is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiMonitoring: type: object description: 'Whether API monitoring is available to the organization.' properties: schedules: type: integer description: 'Whether scheduled flows are available to the organization.' required: - schedules apiCommunityManager: type: object description: 'Whether Anypoint API Community Manager is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiExperienceHub: type: object description: 'Whether Anypoint API Experience Hub is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled monitoringCenter: type: object description: 'Whether Anypoint Monitoring Center is available to the organization.' properties: productSKU: type: integer description: 'The product SKU that identifies the entitlement.' rawStorageOverrideGB: type: integer description: 'Override for the raw storage allowance, in GB.' dataRegion: type: string description: 'The cloud region where data for this organization is stored.' productionUnits: type: integer description: 'Number of production units included in the entitlement.' preProductionUnits: type: integer description: 'Number of pre-production units included in the entitlement.' storageBase: type: integer description: 'Base storage allowance included with the entitlement, in GB.' storageAddOn: type: integer description: 'Additional storage capacity provisioned on top of the base allowance, in GB.' required: - productSKU - rawStorageOverrideGB - dataRegion - productionUnits - preProductionUnits - storageBase - storageAddOn apiQuery: type: object description: 'Whether API Query is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' productSKU: type: integer description: 'The product SKU that identifies the entitlement.' required: - enabled - productSKU apiQueryC360: type: object description: 'Whether API Query for Customer 360 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled rpa: type: object description: 'Whether MuleSoft RPA is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' active: type: boolean description: 'Whether the feature or resource is currently active.' composerVersion: type: string description: 'The version of MuleSoft Composer available to the organization.' required: - enabled - active - composerVersion idp: type: object description: 'Whether the organization can configure its own identity provider.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled AutomationCreditsDW: type: object description: 'Number of automation credits available to the organization in Data Warehouse units.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned apiGovernance: type: object description: 'Whether Anypoint API Governance is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' apisPerMonth: type: integer description: 'Number of APIs the organization is allowed to manage per month.' required: - enabled - apisPerMonth apiGovernanceDomain: type: object description: 'Whether the API Governance domain feature is available to the organization.' properties: domain: type: string description: 'The domain name associated with the organization.' required: - domain crowd: type: object description: 'Whether the Crowd developer experience is available to the organization.' properties: hideApiManagerDesigner: type: boolean description: 'Whether the legacy API Manager designer is hidden from the organization.' hideFormerApiPlatform: type: boolean description: 'Whether the former API Platform UI is hidden from the organization.' environments: type: boolean description: 'The environments configured for the organization.' required: - hideApiManagerDesigner - hideFormerApiPlatform - environments cam: type: object description: 'Whether Anypoint Connectivity Access Management (CAM) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled exchange2: type: object description: 'Whether Anypoint Exchange 2 features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' assetUsageAndEngagement: type: object description: 'Whether asset usage and engagement metrics are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - enabled - assetUsageAndEngagement crowdSelfServiceMigration: type: object description: 'Whether self-service migration to Crowd is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled kpiDashboard: type: object description: 'Whether the KPI dashboard is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled pcf: type: boolean description: 'Whether the Pivotal Cloud Foundry integration is available to the organization.' appViz: type: boolean description: 'Whether Anypoint Application Visualization is available to the organization.' workerClouds: type: object description: 'Whether MuleSoft worker clouds are available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned runtimeFabric: type: boolean description: 'Whether Anypoint Runtime Fabric is available to the organization.' runtimeFabricCloud: type: object description: 'Whether Anypoint Runtime Fabric (Cloud) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled serviceMesh: type: object description: 'Whether Anypoint Service Mesh is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled flexGateway: type: object description: 'Whether Anypoint Omni Gateway is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled managedGatewaySmall: type: object description: 'Number of small managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned managedGatewayLarge: type: object description: 'Number of large managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned rtfManagedGateway: type: object description: 'Number of Runtime Fabric managed gateways available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled composer: type: object description: 'Whether MuleSoft Composer is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' tasksPerMonth: type: integer description: 'Number of tasks the organization is allowed to run per month.' maxConnectors: type: integer description: 'Maximum number of connectors the organization is allowed to use.' unlimitedConnectors: type: boolean description: 'Whether the entitlement allows the use of an unlimited number of connectors.' isHyperAutomation: type: boolean description: 'Whether the entitlement applies to MuleSoft Hyperautomation.' required: - enabled - tasksPerMonth - maxConnectors - unlimitedConnectors - isHyperAutomation muleDxWebIde: type: object description: 'Whether the Mule DX web IDE is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxGenAI: type: object description: 'Whether Mule DX generative AI features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxEDA: type: object description: 'Whether Mule DX event-driven architecture features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled usageBasedPricing: type: object description: 'Whether usage-based pricing applies to the organization.' properties: muleRuntimeIntegration: type: object description: 'Whether Mule Runtime integration features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' flows: type: integer description: 'Flow-related limits associated with the entitlement.' messages: type: integer description: 'Per-message limits or counters defined for the entitlement.' throughput: type: integer description: 'Throughput limits defined for the entitlement.' required: - enabled - flows - messages - throughput required: - muleRuntimeIntegration usageBasedPricingLimits: type: object description: 'Limits that apply to the organization under usage-based pricing.' properties: cpu: type: object description: 'CPU resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra memory: type: object description: 'Memory resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra required: - cpu - memory highAvailability: type: object description: 'Whether the entitlement allows high-availability deployments.' properties: clustering: type: boolean description: 'Whether the entitlement allows clustered deployments.' required: - clustering cloudhub1: type: object description: 'Whether CloudHub 1.0 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled telemetryExporter: type: object description: 'Whether the telemetry exporter is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - partnersProduction - partnersSandbox - tradingPartnersProduction - tradingPartnersSandbox - createSubOrgs - createEnvironments - hybrid - hybridInsight - hybridAutoDiscoverProperties - globalDeployment - vCoresProduction - vCoresSandbox - vCoresDesign - staticIps - vpcs - vpns - networkConnections - workerLoggingOverride - messaging - mqMessages - mqRequests - mqAdvancedFeatures - objectStoreRequestUnits - objectStoreKeys - gateways - designCenter - loadBalancer - externalIdentity - autoscaling - armAlerts - apis - apiCatalog - apiMonitoring - apiCommunityManager - apiExperienceHub - monitoringCenter - apiQuery - apiQueryC360 - rpa - idp - AutomationCreditsDW - apiGovernance - apiGovernanceDomain - crowd - cam - exchange2 - crowdSelfServiceMigration - kpiDashboard - pcf - appViz - workerClouds - runtimeFabric - runtimeFabricCloud - serviceMesh - flexGateway - managedGatewaySmall - managedGatewayLarge - rtfManagedGateway - composer - muleDxWebIde - muleDxGenAI - muleDxEDA - usageBasedPricing - usageBasedPricingLimits - highAvailability - cloudhub1 - telemetryExporter owner: type: object description: 'The user or entity that owns the resource.' properties: id: type: string description: 'The unique identifier of the resource.' username: type: string description: 'The username used to authenticate the user.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email organizationId: type: string description: 'The unique identifier of the organization.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - id - username - firstName - lastName - email - organizationId - enabled subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration environments: type: array description: 'The environments configured for the organization.' items: type: object description: 'The environments configured for the organization.' properties: id: type: string description: 'The unique identifier of the resource.' organizationId: type: string description: 'The unique identifier of the organization.' name: type: string description: 'The display name of the resource.' isProduction: type: boolean description: 'Whether the environment is a production environment.' type: type: string description: 'The type of the resource.' clientId: type: string description: 'The unique identifier of the client application.' required: - id - organizationId - name - isProduction - type - clientId salesforce: type: object description: 'Configuration of the Salesforce integration for the organization.' properties: sf_org_id: type: string description: 'The Salesforce organization identifier associated with this organization.' apiEndpoint: type: string description: 'Endpoint URL of the integrated service.' format: uri required: - sf_org_id - apiEndpoint required: - name - id - createdAt - updatedAt - ownerId - clientId - domain - idprovider_id - isFederated - parentOrganizationIds - subOrganizationIds - tenantOrganizationIds - isRoot - isMaster - properties - entitlements - owner - subscription - environments - salesforce organizationPreferences: type: object description: 'Per-organization user preferences.' properties: f0c9b011-980e-4928-9430-e60e3a97c043: type: object description: 'Per-resource entry keyed by identifier.' properties: defaultEnvironment: type: string description: 'The default environment selected by the user for this organization.' required: - defaultEnvironment required: - f0c9b011-980e-4928-9430-e60e3a97c043 properties: type: object description: 'Additional properties associated with the resource.' properties: {} memberOfOrganizations: type: array description: 'The organizations the user is a member of.' items: type: object description: 'The organizations the user is a member of.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' parentId: type: 'null' description: 'The unique identifier of the parent resource.' parentName: type: 'null' description: 'The display name of the parent resource.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: string description: 'Identifiers of the organizations that are direct children of this organization.' tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration required: - name - id - createdAt - updatedAt - ownerId - clientId - domain - idprovider_id - isFederated - parentId - parentName - parentOrganizationIds - subOrganizationIds - tenantOrganizationIds - isRoot - isMaster - subscription contributorOfOrganizations: type: array description: 'The organizations the user has contributor access to.' items: type: object description: 'The organizations the user has contributor access to.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' parentId: type: 'null' description: 'The unique identifier of the parent resource.' parentName: type: 'null' description: 'The display name of the parent resource.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: string description: 'Identifiers of the organizations that are direct children of this organization.' tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration required: - name - id - createdAt - updatedAt - ownerId - clientId - domain - idprovider_id - isFederated - parentId - parentName - parentOrganizationIds - subOrganizationIds - tenantOrganizationIds - isRoot - isMaster - subscription access_token: type: string description: 'The OAuth 2.0 access token issued to the client.' permissions: type: object description: 'The permissions assigned to the resource.' properties: admin: type: object description: 'Whether administrative access is granted by the resource.' properties: view: type: boolean description: 'The view granted to the resource.' required: - view cloudhub: type: object description: 'Whether CloudHub access is granted by the resource.' properties: view: type: boolean description: 'The view granted to the resource.' required: - view exchange: type: object description: 'Whether Exchange access is granted by the resource.' properties: view: type: boolean description: 'The view granted to the resource.' required: - view support: type: object description: 'The level of support available to the organization.' properties: view: type: boolean description: 'The view granted to the resource.' required: - view partner_manager: type: object description: 'Whether Partner Manager access is granted by the resource.' properties: view: type: boolean description: 'The view granted to the resource.' required: - view required: - admin - cloudhub - exchange - support - partner_manager required: - id - createdAt - updatedAt - lastLogin - previousLastLogin - firstName - lastName - email - phoneNumber - username - enabled - deleted - idprovider_id - type - organizationId - organization - organizationPreferences - properties - memberOfOrganizations - contributorOfOrganizations - access_token - permissions '401': description: Unauthorized. There is no user attached to the token '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get user profile for access token operationId: listProfile /recover: description: recover user's account /recover/password: post: description: sends a 'forgot password' email with password reset link to the email associated with the given username x-optionalSecurity: true requestBody: content: application/json: schema: type: object required: - username properties: username: type: string example: username: cmordue x-amf-mediaType: application/json description: Request payload for create recover password. responses: '200': description: email was sent or user with username does not exist x-amf-mediaType: text/plain content: text/plain: example: OK schema: type: string description: 'Response payload for createRecoverPassword.' '400': description: Bad request; missing username parameter '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - {} summary: Send password reset email operationId: createRecoverPassword /recover/password/{recoverCode}: description: reset password get: description: Checks the validity of the password reset code x-optionalSecurity: true parameters: - name: recoverCode description: A code sent in a password reset email used to prove the bearer has the right to change a user's password required: true in: path schema: type: string responses: '200': description: the code is valid x-amf-mediaType: text/plain content: text/plain: example: OK schema: type: string description: 'Response payload for listRecoverPassword.' '404': description: the code does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - {} summary: Check password reset code operationId: listRecoverPassword post: description: Sets a new password for the user associated with the password reset code x-optionalSecurity: true parameters: - name: recoverCode description: A code sent in a password reset email used to prove the bearer has the right to change a user's password required: true in: path schema: type: string requestBody: content: application/json: schema: type: object required: - password - confirmPassword properties: password: type: string minLength: 6 confirmPassword: type: string minLength: 6 example: password: Password1 confirmPassword: Password1 x-amf-mediaType: application/json description: Request payload for create recover password2. responses: '200': description: the password was successfully reset x-amf-mediaType: text/plain content: text/plain: example: OK schema: type: string description: 'Response payload for createRecoverPasswordByCode.' '400': description: any of the code, password or confirmPassword are missing or password and confirmPassword do not match '404': description: the code does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - {} summary: Reset password with reset code operationId: createRecoverPasswordByCode /recover/username: post: description: sends email with list of usernames associated with the given email x-optionalSecurity: true requestBody: content: application/json: schema: type: object required: - email properties: email: type: string example: email: christopher.mordue@mulesoft.com x-amf-mediaType: application/json description: Request payload for create recover username. responses: '200': description: email was sent or no users are associated with the given email '400': description: Bad request; missing email parameter '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - {} summary: Send username recovery email operationId: createRecoverUsername /roles: description: Roles resource get: description: Retrieves a list of roles parameters: - name: name description: The name of a role required: false in: query schema: type: string - name: description description: The description of a role required: false in: query schema: type: string - name: include_internal description: Include internal roles required: false in: query schema: type: boolean default: false - name: offset description: The number of records to omit from the response. required: false in: query schema: type: integer minimum: 0 default: 0 - name: limit description: Maximum records to retrieve per request. required: false in: query schema: type: integer minimum: 0 maximum: 500 default: 25 - name: search description: A search string to use for case-insensitive partial matches on role names required: false in: query schema: type: string - name: sort description: The field to sort on. required: false in: query schema: type: string enum: - name - role_id - description - internal default: name - name: ascending description: Whether to sort ascending or descending required: true in: query schema: type: boolean default: true x-amf-queryParameters: product: description: Only include roles associated with this product name required: false anyOf: - type: string - items: type: string responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for listRoles.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: role_id: type: string description: 'The unique identifier of the role.' name: type: string description: 'The display name of the resource.' description: type: string description: 'A human-readable description of the resource.' internal: type: boolean description: 'Whether the resource is for internal use only.' org_id: type: 'null' description: 'The unique identifier of the organization.' namespaces: type: array description: 'The list of permission namespaces affected by the request.' items: type: object product: type: string description: 'The MuleSoft product the resource belongs to.' required: - role_id - name - description - internal - org_id - namespaces - product total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List roles operationId: listRoles /roles/{roleId}: description: A single role get: description: Returns a single role by ID parameters: - $ref: '#/components/parameters/XOrigin_globalRoleId_Path' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get a role operationId: getRoles /roles/{roleId}/users: description: Users by role get: description: Returns users for a single role. This endpoint is rate lmited. parameters: - $ref: '#/components/parameters/XOrigin_globalRoleId_Path' responses: '200': description: Success headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make per hour. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List users assigned to a role operationId: listRolesUsers /roles/{roleId}/permissions: description: Permissions by a single role get: description: List permissions assigned to a given role parameters: - $ref: '#/components/parameters/XOrigin_globalRoleId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: data: 5 schema: type: object description: 'Response payload for listRolesPermissions.' properties: data: type: integer description: 'The list of items returned by the request.' required: - data '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List permissions assigned to a role operationId: listRolesPermissions /roles/rolegroups: {} /roles/rolegroups/search: description: Search rolegroups by role assignments post: description: Search rolegroups by role assignments requestBody: content: application/json: schema: type: array maxItems: 3 minItems: 1 uniqueItems: true items: anyOf: - type: object additionalProperties: false required: - name - operator - operands properties: name: type: string operator: enum: - AND - OR type: string operands: type: array maxItems: 5 minItems: 1 uniqueItems: true items: type: object additionalProperties: false required: - role_id - context_params - match_type properties: role_id: type: string minLength: 36 maxLength: 36 context_params: type: object additionalProperties: type: string match_type: default: partial enum: - exact - partial type: string - type: object additionalProperties: false required: - name - limit - offset properties: name: type: string limit: type: number minimum: 0 maximum: 25 offset: type: number minimum: 0 - type: object additionalProperties: false required: - name - order - field properties: name: type: string order: enum: - ASC - DESC type: string field: enum: - role_group_id - name type: string example: - 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 x-amf-mediaType: application/json description: Request payload for create roles rolegroups search. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/RoleGroupApiResponse' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Search role groups by role operationId: createRolesRolegroupsSearch /roles/teams: description: Teams by role /roles/teams/search: description: Search teams by role assignments post: description: Search teams by role assignments parameters: - name: include_inherited description: Include child teams who inherited the matching permissions in: query schema: type: string requestBody: content: application/json: schema: type: array maxItems: 3 minItems: 1 uniqueItems: true items: anyOf: - type: object additionalProperties: false required: - name - operator - operands properties: name: type: string operator: enum: - AND - OR type: string operands: type: array maxItems: 5 minItems: 1 uniqueItems: true items: oneOf: - type: object required: - role_id properties: role_id: {} - type: object required: - org_id properties: org_id: {} type: object additionalProperties: false required: - context_params - match_type properties: org_id: type: string minLength: 36 maxLength: 36 role_id: type: string minLength: 36 maxLength: 36 context_params: type: object additionalProperties: type: string match_type: default: partial enum: - exact - partial type: string - type: object additionalProperties: false required: - name - limit - offset properties: name: type: string limit: type: number minimum: 0 maximum: 25 offset: type: number minimum: 0 - type: object additionalProperties: false required: - name - order - field properties: name: type: string order: enum: - ASC - DESC type: string field: enum: - team_id - name - team_name - first_name - firstName - last_name - lastName - username type: string example: - 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 x-amf-mediaType: application/json description: Request payload for create roles teams search. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/TeamRoleSearchResult' total: type: number example: 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-15 09:36:07.123000+00:00 updated_at: 2019-07-15 09: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-21 11:11:48.204521-07:00 total: 1 '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Search teams by role assignments operationId: createRolesTeamsSearch /roles/users: description: Users by role get: description: Retrieve users by roles parameters: - name: role_groups description: Flag that indicates if we should include role groups assignments when looking for the role required: true in: query schema: type: boolean default: false - name: teams description: Flag that indicates if we should include team role assignments when looking for the role required: true in: query schema: type: boolean default: false responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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-21 11: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-21 11:11:48.204521-07:00 total: 1 schema: type: object description: 'Response payload for listAllRolesUsers.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: id: type: string description: 'The unique identifier of the resource.' username: type: string description: 'The username used to authenticate the user.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' type: type: string description: 'The type of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' organizationId: type: string description: 'The unique identifier of the organization.' assignments: type: array description: 'The role and team assignments associated with the user or client.' items: type: object description: 'The role and team assignments associated with the user or client.' properties: role_id: type: string description: 'The unique identifier of the role.' context_params: type: object description: 'Additional parameters that scope the operation to a specific organization or environment.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' user: type: string description: 'The user associated with the resource.' required: - org - user created_at: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' required: - role_id - context_params - created_at required: - id - username - firstName - lastName - email - enabled - idprovider_id - type - createdAt - updatedAt - lastLogin - organizationId - assignments total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List users across role assignments operationId: listAllRolesUsers /roles/users/search: description: Search users by role assignments post: description: Seach users by role assignments requestBody: content: application/json: schema: type: array maxItems: 3 minItems: 1 uniqueItems: true items: anyOf: - type: object additionalProperties: false required: - name - operator - operands properties: name: type: string operator: enum: - AND - OR type: string operands: type: array maxItems: 5 minItems: 1 uniqueItems: true items: oneOf: - type: object required: - role_id properties: role_id: {} - type: object required: - org_id properties: org_id: {} type: object additionalProperties: false required: - context_params - match_type properties: org_id: type: string minLength: 36 maxLength: 36 role_id: type: string minLength: 36 maxLength: 36 context_params: type: object additionalProperties: type: string match_type: default: partial enum: - exact - partial type: string - type: object additionalProperties: false required: - name - limit - offset properties: name: type: string limit: type: number minimum: 0 maximum: 500 offset: type: number minimum: 0 - type: object additionalProperties: false required: - name - order - field properties: name: type: string order: enum: - ASC - DESC type: string field: enum: - id - first_name - firstName - last_name - lastName - username type: string example: - 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 x-amf-mediaType: application/json description: Request payload for create roles users search. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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-21 11: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-21 11:11:48.204521-07:00 total: 1 schema: type: object description: 'Response payload for createRolesUsersSearch.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: id: type: string description: 'The unique identifier of the resource.' username: type: string description: 'The username used to authenticate the user.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' type: type: string description: 'The type of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' organizationId: type: string description: 'The unique identifier of the organization.' assignments: type: array description: 'The role and team assignments associated with the user or client.' items: type: object description: 'The role and team assignments associated with the user or client.' properties: role_id: type: string description: 'The unique identifier of the role.' context_params: type: object description: 'Additional parameters that scope the operation to a specific organization or environment.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' user: type: string description: 'The user associated with the resource.' required: - org - user created_at: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' required: - role_id - context_params - created_at required: - id - username - firstName - lastName - email - enabled - idprovider_id - type - createdAt - updatedAt - lastLogin - organizationId - assignments total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Search users by role assignments operationId: createRolesUsersSearch /session: description: The session associated with the caller get: description: Retrieves session timeout meta data responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: timeout: unit: milliseconds duration: 3600000 timeLeft: 3599968 timeUsed: 32 expires: 1422910648297 schema: type: object description: 'Response payload for listSession.' properties: timeout: type: object description: 'The timeout for the operation, in milliseconds.' properties: unit: type: string description: 'The unit of measurement that applies to the value.' duration: type: integer description: 'The duration associated with the resource.' timeLeft: type: integer description: 'Remaining time before the resource expires, in milliseconds.' timeUsed: type: integer description: 'Elapsed time consumed by the resource, in milliseconds.' expires: type: integer description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - unit - duration - timeLeft - timeUsed - expires required: - timeout '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get session timeout metadata operationId: listSession post: description: Extend the session timeout time responses: '204': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Extend the session timeout operationId: createSession /signup: description: Signup for the Anypoint Platform get: description: Retrieves data about joining an organization via invite code x-optionalSecurity: true parameters: - name: code description: Invite code required: true in: query schema: type: string responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for listSignup.' properties: organizationName: type: string description: 'The display name of the organization.' organizationId: type: string description: 'The unique identifier of the organization.' email: type: string description: 'The user''s email address.' format: email userAccounts: type: array description: 'The user accounts associated with the resource.' items: type: object description: 'The user accounts associated with the resource.' properties: username: type: string description: 'The username used to authenticate the user.' attachedOrg: type: boolean description: 'Information about the parent organization this organization is attached to.' required: - username - attachedOrg termsAccepted: type: boolean description: 'Whether the user has accepted the terms of service.' required: - organizationName - organizationId - email - userAccounts - termsAccepted '400': description: Missing or invalid invite code '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - {} summary: Get invite signup metadata operationId: listSignup post: description: "Creates a new user and organization, or accepts an invite to join\ \ an existing organization.\nSupports two modes: full signup or accepting\ \ an invite via code.\nAuthentication: For full signup, either provide captchaCode\ \ or Authorization header. \n" x-optionalSecurity: true requestBody: content: application/json: schema: type: object examples: accept-invite: value: 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: value: 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' x-amf-mediaType: application/json description: Request payload for create signup. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: id: 5197cdf3-36c9-4bcb-8840-5779e961c746 createdAt: 2015-01-29 00:00:53.315000+00:00 updatedAt: 2015-01-29 00:00:55.163000+00:00 lastLogin: 2015-01-29 00:11:55.163000+00:00 previousLastLogin: 2015-01-28 00:11:55.163000+00:00 firstName: Organization lastName: Owner ipAllowlistExcluded: false email: core_services@mulesoft.com email_verified_at: 2015-01-29 00: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-03 00:20:06.125000+00:00 ownerId: 57e281b5-ec5b-4701-80a0-92a936a68da3 updatedAt: 2015-02-03 00: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-27 20:56:02.125000+00:00 properties: {} schema: type: object description: 'Response payload for createSignup.' properties: id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' previousLastLogin: type: string description: 'The date and time of the user''s previous successful login, in ISO 8601 format.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' ipAllowlistExcluded: type: boolean description: 'Whether the resource is excluded from organization-level IP allowlist enforcement.' email: type: string description: 'The user''s email address.' format: email email_verified_at: type: string description: 'The date and time when the user''s email address was verified, in ISO 8601 format.' phoneNumber: type: string description: 'The user''s phone number.' username: type: string description: 'The username used to authenticate the user.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' deleted: type: boolean description: 'Whether the resource has been marked as deleted.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' organization: type: object description: 'The organization that owns the resource.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' properties: type: object description: 'Additional properties associated with the resource.' properties: defaultAccessManagementUi: type: string description: 'The Access Management UI variant the organization defaults to.' required: - defaultAccessManagementUi entitlements: type: object description: 'The features and capabilities the organization is entitled to use.' properties: createSubOrgs: type: boolean description: 'Whether the organization is allowed to create sub-organizations.' createEnvironments: type: boolean description: 'Whether the organization is allowed to create environments.' hybrid: type: object description: 'Whether hybrid deployments are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled hybridInsight: type: boolean description: 'Whether Hybrid Insight is available to the organization.' hybridAutoDiscoverProperties: type: boolean description: 'Whether hybrid runtimes can auto-discover platform properties.' globalDeployment: type: boolean description: 'Whether the entitlement allows global deployment of MuleSoft applications.' vCoresProduction: type: object description: 'Number of production vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresSandbox: type: object description: 'Number of sandbox vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresDesign: type: object description: 'Number of design-time vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned staticIps: type: object description: 'Number of static IPs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpcs: type: object description: 'Number of Anypoint VPCs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpns: type: object description: 'Number of VPN connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned networkConnections: type: object description: 'Number of network connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned workerLoggingOverride: type: object description: 'Whether the organization can override worker logging configuration.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled messaging: type: object description: 'Whether Anypoint MQ is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned mqMessages: type: object description: 'Number of Anypoint MQ messages included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqRequests: type: object description: 'Number of Anypoint MQ requests included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqAdvancedFeatures: type: object description: 'Whether Anypoint MQ advanced features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled objectStoreRequestUnits: type: object description: 'Number of Object Store request units included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn objectStoreKeys: type: object description: 'Number of Object Store keys included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn gateways: type: object description: 'Number of API gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned designCenter: type: object description: 'Whether Anypoint Design Center is available to the organization.' properties: mozart: type: boolean description: 'Whether MuleSoft Mozart is available to the organization.' api: type: boolean description: 'Per-API capacity included in the entitlement.' apiVisual: type: boolean description: 'Whether the visual API designer is available to the organization.' apiExample: type: boolean description: 'Whether API example projects are available to the organization.' required: - mozart - api - apiVisual - apiExample partnersProduction: type: object description: 'Whether production capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned partnersSandbox: type: object description: 'Whether sandbox capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersProduction: type: object description: 'Whether B2B Trading Partner Manager production capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersSandbox: type: object description: 'Whether B2B Trading Partner Manager sandbox capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned loadBalancer: type: object description: 'Number of dedicated load balancers available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned externalIdentity: type: boolean description: 'Whether the user belongs to an external identity provider.' autoscaling: type: boolean description: 'Whether deployment autoscaling is available to the organization.' armAlerts: type: boolean description: 'Whether Anypoint Runtime Manager alerts are available to the organization.' apis: type: object description: 'Per-API limits or counters defined for the entitlement.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiCatalog: type: object description: 'Whether the API catalog is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiMonitoring: type: object description: 'Whether API monitoring is available to the organization.' properties: schedules: type: integer description: 'Whether scheduled flows are available to the organization.' required: - schedules apiCommunityManager: type: object description: 'Whether Anypoint API Community Manager is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiExperienceHub: type: object description: 'Whether Anypoint API Experience Hub is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled monitoringCenter: type: object description: 'Whether Anypoint Monitoring Center is available to the organization.' properties: productSKU: type: integer description: 'The product SKU that identifies the entitlement.' rawStorageOverrideGB: type: integer description: 'Override for the raw storage allowance, in GB.' dataRegion: type: string description: 'The cloud region where data for this organization is stored.' productionUnits: type: integer description: 'Number of production units included in the entitlement.' preProductionUnits: type: integer description: 'Number of pre-production units included in the entitlement.' storageBase: type: integer description: 'Base storage allowance included with the entitlement, in GB.' storageAddOn: type: integer description: 'Additional storage capacity provisioned on top of the base allowance, in GB.' required: - productSKU - rawStorageOverrideGB - dataRegion - productionUnits - preProductionUnits - storageBase - storageAddOn apiQuery: type: object description: 'Whether API Query is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' productSKU: type: integer description: 'The product SKU that identifies the entitlement.' required: - enabled - productSKU apiQueryC360: type: object description: 'Whether API Query for Customer 360 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled rpa: type: object description: 'Whether MuleSoft RPA is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' active: type: boolean description: 'Whether the feature or resource is currently active.' composerVersion: type: string description: 'The version of MuleSoft Composer available to the organization.' required: - enabled - active - composerVersion idp: type: object description: 'Whether the organization can configure its own identity provider.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled AutomationCreditsDW: type: object description: 'Number of automation credits available to the organization in Data Warehouse units.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned apiGovernance: type: object description: 'Whether Anypoint API Governance is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' apisPerMonth: type: integer description: 'Number of APIs the organization is allowed to manage per month.' required: - enabled - apisPerMonth apiGovernanceDomain: type: object description: 'Whether the API Governance domain feature is available to the organization.' properties: domain: type: string description: 'The domain name associated with the organization.' required: - domain crowd: type: object description: 'Whether the Crowd developer experience is available to the organization.' properties: hideApiManagerDesigner: type: boolean description: 'Whether the legacy API Manager designer is hidden from the organization.' hideFormerApiPlatform: type: boolean description: 'Whether the former API Platform UI is hidden from the organization.' environments: type: boolean description: 'The environments configured for the organization.' required: - hideApiManagerDesigner - hideFormerApiPlatform - environments cam: type: object description: 'Whether Anypoint Connectivity Access Management (CAM) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled exchange2: type: object description: 'Whether Anypoint Exchange 2 features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' assetUsageAndEngagement: type: object description: 'Whether asset usage and engagement metrics are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - enabled - assetUsageAndEngagement crowdSelfServiceMigration: type: object description: 'Whether self-service migration to Crowd is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled kpiDashboard: type: object description: 'Whether the KPI dashboard is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled pcf: type: boolean description: 'Whether the Pivotal Cloud Foundry integration is available to the organization.' appViz: type: boolean description: 'Whether Anypoint Application Visualization is available to the organization.' workerClouds: type: object description: 'Whether MuleSoft worker clouds are available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned runtimeFabric: type: boolean description: 'Whether Anypoint Runtime Fabric is available to the organization.' runtimeFabricCloud: type: object description: 'Whether Anypoint Runtime Fabric (Cloud) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled serviceMesh: type: object description: 'Whether Anypoint Service Mesh is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled flexGateway: type: object description: 'Whether Anypoint Omni Gateway is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled managedGatewaySmall: type: object description: 'Number of small managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned managedGatewayLarge: type: object description: 'Number of large managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned rtfManagedGateway: type: object description: 'Number of Runtime Fabric managed gateways available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled composer: type: object description: 'Whether MuleSoft Composer is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' tasksPerMonth: type: integer description: 'Number of tasks the organization is allowed to run per month.' maxConnectors: type: integer description: 'Maximum number of connectors the organization is allowed to use.' unlimitedConnectors: type: boolean description: 'Whether the entitlement allows the use of an unlimited number of connectors.' isHyperAutomation: type: boolean description: 'Whether the entitlement applies to MuleSoft Hyperautomation.' required: - enabled - tasksPerMonth - maxConnectors - unlimitedConnectors - isHyperAutomation muleDxWebIde: type: object description: 'Whether the Mule DX web IDE is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxGenAI: type: object description: 'Whether Mule DX generative AI features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxEDA: type: object description: 'Whether Mule DX event-driven architecture features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled usageBasedPricing: type: object description: 'Whether usage-based pricing applies to the organization.' properties: muleRuntimeIntegration: type: object description: 'Whether Mule Runtime integration features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' flows: type: integer description: 'Flow-related limits associated with the entitlement.' messages: type: integer description: 'Per-message limits or counters defined for the entitlement.' throughput: type: integer description: 'Throughput limits defined for the entitlement.' required: - enabled - flows - messages - throughput required: - muleRuntimeIntegration usageBasedPricingLimits: type: object description: 'Limits that apply to the organization under usage-based pricing.' properties: cpu: type: object description: 'CPU resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra memory: type: object description: 'Memory resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra required: - cpu - memory highAvailability: type: object description: 'Whether the entitlement allows high-availability deployments.' properties: clustering: type: boolean description: 'Whether the entitlement allows clustered deployments.' required: - clustering cloudhub1: type: object description: 'Whether CloudHub 1.0 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled telemetryExporter: type: object description: 'Whether the telemetry exporter is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - createSubOrgs - createEnvironments - hybrid - hybridInsight - hybridAutoDiscoverProperties - globalDeployment - vCoresProduction - vCoresSandbox - vCoresDesign - staticIps - vpcs - vpns - networkConnections - workerLoggingOverride - messaging - mqMessages - mqRequests - mqAdvancedFeatures - objectStoreRequestUnits - objectStoreKeys - gateways - designCenter - partnersProduction - partnersSandbox - tradingPartnersProduction - tradingPartnersSandbox - loadBalancer - externalIdentity - autoscaling - armAlerts - apis - apiCatalog - apiMonitoring - apiCommunityManager - apiExperienceHub - monitoringCenter - apiQuery - apiQueryC360 - rpa - idp - AutomationCreditsDW - apiGovernance - apiGovernanceDomain - crowd - cam - exchange2 - crowdSelfServiceMigration - kpiDashboard - pcf - appViz - workerClouds - runtimeFabric - runtimeFabricCloud - serviceMesh - flexGateway - managedGatewaySmall - managedGatewayLarge - rtfManagedGateway - composer - muleDxWebIde - muleDxGenAI - muleDxEDA - usageBasedPricing - usageBasedPricingLimits - highAvailability - cloudhub1 - telemetryExporter isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: object tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration required: - name - id - createdAt - ownerId - updatedAt - clientId - domain - idprovider_id - properties - entitlements - isFederated - isRoot - isMaster - parentOrganizationIds - subOrganizationIds - tenantOrganizationIds - subscription properties: type: object description: 'Additional properties associated with the resource.' properties: {} required: - id - createdAt - updatedAt - lastLogin - previousLastLogin - firstName - lastName - ipAllowlistExcluded - email - email_verified_at - phoneNumber - username - enabled - deleted - idprovider_id - organization - properties '400': description: Bad request; invalid or missing fields; username, password, email, firstName, lastName or user already exists, etc. '403': description: Request from forbidden country '409': description: Conflict - User already exists '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - {} summary: Create user via signup or invite operationId: createSignup /signup/existingUser: description: Information about signing up (accepting an invite) with an existing user post: description: Get information about signing up (accepting an invite) with an existing user x-optionalSecurity: true requestBody: content: application/json: example: username: max password: Password1 schema: type: object description: 'Request payload for createSignupExistingUser.' properties: username: type: string description: 'The username used to authenticate the user.' password: type: string description: 'The user''s password. Write-only.' required: - username - password x-amf-mediaType: application/json description: Request payload for create signup existing user. responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: id: 5197cdf3-36c9-4bcb-8840-5779e961c746 createdAt: 2015-01-29 00:00:53.315000+00:00 updatedAt: 2015-01-29 00: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-03 00:20:06.125000+00:00 ownerId: 57e281b5-ec5b-4701-80a0-92a936a68da3 updatedAt: 2015-02-03 00: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-27 20:56:02.125000+00:00 properties: {} attachmentType: onlyUser schema: type: object description: 'Response payload for createSignupExistingUser.' properties: id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email phoneNumber: type: string description: 'The user''s phone number.' username: type: string description: 'The username used to authenticate the user.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' deleted: type: boolean description: 'Whether the resource has been marked as deleted.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' organization: type: object description: 'The organization that owns the resource.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' properties: type: object description: 'Additional properties associated with the resource.' properties: defaultAccessManagementUi: type: string description: 'The Access Management UI variant the organization defaults to.' required: - defaultAccessManagementUi entitlements: type: object description: 'The features and capabilities the organization is entitled to use.' properties: createSubOrgs: type: boolean description: 'Whether the organization is allowed to create sub-organizations.' createEnvironments: type: boolean description: 'Whether the organization is allowed to create environments.' hybrid: type: object description: 'Whether hybrid deployments are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled hybridInsight: type: boolean description: 'Whether Hybrid Insight is available to the organization.' globalDeployment: type: boolean description: 'Whether the entitlement allows global deployment of MuleSoft applications.' vCoresProduction: type: object description: 'Number of production vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresSandbox: type: object description: 'Number of sandbox vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresDesign: type: object description: 'Number of design-time vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned staticIps: type: object description: 'Number of static IPs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpcs: type: object description: 'Number of Anypoint VPCs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned workerLoggingOverride: type: object description: 'Whether the organization can override worker logging configuration.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled messaging: type: object description: 'Whether Anypoint MQ is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned mqMessages: type: object description: 'Number of Anypoint MQ messages included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqRequests: type: object description: 'Number of Anypoint MQ requests included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqAdvancedFeatures: type: object description: 'Whether Anypoint MQ advanced features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled objectStoreRequestUnits: type: object description: 'Number of Object Store request units included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn objectStoreKeys: type: object description: 'Number of Object Store keys included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn gateways: type: object description: 'Number of API gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned designCenter: type: object description: 'Whether Anypoint Design Center is available to the organization.' properties: mozart: type: boolean description: 'Whether MuleSoft Mozart is available to the organization.' api: type: boolean description: 'Per-API capacity included in the entitlement.' apiVisual: type: boolean description: 'Whether the visual API designer is available to the organization.' apiExample: type: boolean description: 'Whether API example projects are available to the organization.' required: - mozart - api - apiVisual - apiExample partnersProduction: type: object description: 'Whether production capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned partnersSandbox: type: object description: 'Whether sandbox capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned loadBalancer: type: object description: 'Number of dedicated load balancers available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned externalIdentity: type: boolean description: 'Whether the user belongs to an external identity provider.' autoscaling: type: boolean description: 'Whether deployment autoscaling is available to the organization.' armAlerts: type: boolean description: 'Whether Anypoint Runtime Manager alerts are available to the organization.' apis: type: object description: 'Per-API limits or counters defined for the entitlement.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiCatalog: type: object description: 'Whether the API catalog is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiMonitoring: type: object description: 'Whether API monitoring is available to the organization.' properties: schedules: type: integer description: 'Whether scheduled flows are available to the organization.' required: - schedules apiCommunityManager: type: object description: 'Whether Anypoint API Community Manager is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled monitoringCenter: type: object description: 'Whether Anypoint Monitoring Center is available to the organization.' properties: productSKU: type: integer description: 'The product SKU that identifies the entitlement.' rawStorageOverrideGB: type: integer description: 'Override for the raw storage allowance, in GB.' dataRegion: type: string description: 'The cloud region where data for this organization is stored.' productionUnits: type: integer description: 'Number of production units included in the entitlement.' preProductionUnits: type: integer description: 'Number of pre-production units included in the entitlement.' storageBase: type: integer description: 'Base storage allowance included with the entitlement, in GB.' storageAddOn: type: integer description: 'Additional storage capacity provisioned on top of the base allowance, in GB.' required: - productSKU - rawStorageOverrideGB - dataRegion - productionUnits - preProductionUnits - storageBase - storageAddOn apiQuery: type: object description: 'Whether API Query is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' productSKU: type: integer description: 'The product SKU that identifies the entitlement.' required: - enabled - productSKU apiQueryC360: type: object description: 'Whether API Query for Customer 360 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled rpa: type: object description: 'Whether MuleSoft RPA is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' active: type: boolean description: 'Whether the feature or resource is currently active.' composerVersion: type: string description: 'The version of MuleSoft Composer available to the organization.' required: - enabled - active - composerVersion idp: type: object description: 'Whether the organization can configure its own identity provider.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled AutomationCreditsDW: type: object description: 'Number of automation credits available to the organization in Data Warehouse units.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned angGovernance: type: object description: 'Whether the Anypoint API Governance feature is enabled for the organization.' properties: level: type: integer description: 'The level or tier of the resource.' required: - level apiGovernance: type: object description: 'Whether Anypoint API Governance is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' apisPerMonth: type: integer description: 'Number of APIs the organization is allowed to manage per month.' required: - enabled - apisPerMonth apiGovernanceDomain: type: object description: 'Whether the API Governance domain feature is available to the organization.' properties: domain: type: string description: 'The domain name associated with the organization.' required: - domain crowd: type: object description: 'Whether the Crowd developer experience is available to the organization.' properties: hideApiManagerDesigner: type: boolean description: 'Whether the legacy API Manager designer is hidden from the organization.' hideFormerApiPlatform: type: boolean description: 'Whether the former API Platform UI is hidden from the organization.' environments: type: boolean description: 'The environments configured for the organization.' required: - hideApiManagerDesigner - hideFormerApiPlatform - environments cam: type: object description: 'Whether Anypoint Connectivity Access Management (CAM) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled exchange2: type: object description: 'Whether Anypoint Exchange 2 features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' assetUsageAndEngagement: type: object description: 'Whether asset usage and engagement metrics are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - enabled - assetUsageAndEngagement crowdSelfServiceMigration: type: object description: 'Whether self-service migration to Crowd is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled kpiDashboard: type: object description: 'Whether the KPI dashboard is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled pcf: type: boolean description: 'Whether the Pivotal Cloud Foundry integration is available to the organization.' appViz: type: boolean description: 'Whether Anypoint Application Visualization is available to the organization.' workerClouds: type: object description: 'Whether MuleSoft worker clouds are available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned runtimeFabric: type: boolean description: 'Whether Anypoint Runtime Fabric is available to the organization.' runtimeFabricCloud: type: object description: 'Whether Anypoint Runtime Fabric (Cloud) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled serviceMesh: type: object description: 'Whether Anypoint Service Mesh is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled flexGateway: type: object description: 'Whether Anypoint Omni Gateway is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled managedGatewaySmall: type: object description: 'Number of small managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned managedGatewayLarge: type: object description: 'Number of large managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned rtfManagedGateway: type: object description: 'Number of Runtime Fabric managed gateways available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled composer: type: object description: 'Whether MuleSoft Composer is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' tasksPerMonth: type: integer description: 'Number of tasks the organization is allowed to run per month.' maxConnectors: type: integer description: 'Maximum number of connectors the organization is allowed to use.' unlimitedConnectors: type: boolean description: 'Whether the entitlement allows the use of an unlimited number of connectors.' isHyperAutomation: type: boolean description: 'Whether the entitlement applies to MuleSoft Hyperautomation.' required: - enabled - tasksPerMonth - maxConnectors - unlimitedConnectors - isHyperAutomation muleDxWebIde: type: object description: 'Whether the Mule DX web IDE is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxGenAI: type: object description: 'Whether Mule DX generative AI features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxEDA: type: object description: 'Whether Mule DX event-driven architecture features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled cloudhub1: type: object description: 'Whether CloudHub 1.0 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled telemetryExporter: type: object description: 'Whether the telemetry exporter is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - createSubOrgs - createEnvironments - hybrid - hybridInsight - globalDeployment - vCoresProduction - vCoresSandbox - vCoresDesign - staticIps - vpcs - workerLoggingOverride - messaging - mqMessages - mqRequests - mqAdvancedFeatures - objectStoreRequestUnits - objectStoreKeys - gateways - designCenter - partnersProduction - partnersSandbox - loadBalancer - externalIdentity - autoscaling - armAlerts - apis - apiCatalog - apiMonitoring - apiCommunityManager - monitoringCenter - apiQuery - apiQueryC360 - rpa - idp - AutomationCreditsDW - angGovernance - apiGovernance - apiGovernanceDomain - crowd - cam - exchange2 - crowdSelfServiceMigration - kpiDashboard - pcf - appViz - workerClouds - runtimeFabric - runtimeFabricCloud - serviceMesh - flexGateway - managedGatewaySmall - managedGatewayLarge - rtfManagedGateway - composer - muleDxWebIde - muleDxGenAI - muleDxEDA - cloudhub1 - telemetryExporter isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: object tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration required: - name - id - createdAt - ownerId - updatedAt - clientId - domain - idprovider_id - properties - entitlements - isFederated - isRoot - isMaster - parentOrganizationIds - subOrganizationIds - tenantOrganizationIds - subscription properties: type: object description: 'Additional properties associated with the resource.' properties: {} attachmentType: type: string description: 'The kind of attachment associated with the resource.' required: - id - createdAt - updatedAt - firstName - lastName - email - phoneNumber - username - enabled - deleted - idprovider_id - organization - properties - attachmentType '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - {} summary: Accept invite as existing user operationId: createSignupExistingUser /status: description: Application healthcheck, used by the load balancer to detect the instance status. get: description: Retrieves the health of the application. x-optionalSecurity: true parameters: - name: db description: Flag that indicates if we should perform a root DB connection check or not as part of the healthcheck. required: true in: query schema: type: boolean default: false - name: replicas description: Flag that indicates if we should check all replica DB connections or not as part of the healthcheck. required: true in: query schema: type: boolean default: false - name: arc description: Flag that indicates if we should check if ARC (Anypoint Roles Clients) is loaded as part of the healthcheck. required: true in: query schema: type: boolean default: false - name: keys description: Flag that indicates if we should check if the JWKS key store is loaded as part of the healthcheck. required: true in: query schema: type: boolean default: false - name: ld description: Flag that indicates if we should check if the LaunchDarkly client is initialized as part of the healthcheck. required: true in: query schema: type: boolean default: false - name: all description: Flag that indicates if we should perform all registered checks required: true in: query schema: type: boolean default: false responses: '200': description: Everything is working ok. x-amf-mediaType: application/json content: application/json: example: status: ok schema: type: object description: 'Response payload for listStatus.' properties: status: type: string description: 'The current status of the resource.' required: - status '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number '503': description: The application isn't working properly, and shouldn't accept incoming requests. x-amf-mediaType: application/json content: application/json: example: status: quiesced schema: type: object description: 'Response payload for listUsers.' properties: status: type: string description: 'The current status of the resource.' required: - status security: - {} summary: Get application health status operationId: listStatus /subscriptions: description: Subscriptions get: description: Retrieve the subscriptions supported responses: '200': description: Success x-amf-mediaType: application/json content: application/json: schema: type: object additionalProperties: false patternProperties: ^[a-zA-Z]+$: type: array items: type: object additionalProperties: false required: - name - description properties: name: type: string minLength: 1 maxLength: 255 description: type: string minLength: 1 maxLength: 255 example: 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 '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List supported subscriptions operationId: listSubscriptions /support: description: Support portal get: description: Redirect to the support portal or the getting help documentation responses: '302': description: 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 '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number '500': description: Support portal not available or an unknown error occurred security: - bearerAuth: [] - clientAuth: [] summary: Redirect to support portal operationId: listSupport /username/{username}: get: description: Check if the username is already taken x-optionalSecurity: true parameters: - name: username description: Username to search required: true in: path schema: type: string responses: '200': description: Username exists '404': description: Username if available '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - {} summary: Check username availability operationId: getUsername /users: description: Users Resource get: description: Returns a group of users parameters: - name: deleted description: Specify if you want to retrieve only deleted required: true in: query schema: type: boolean default: false - name: type description: Specify the type of user you want to retrieve. required: true in: query schema: type: string enum: - host - proxy - all default: host - name: mfaVerificationExcluded description: Specify if you want to retrieve only users with a given mfaVerificationExcluded value required: true in: query schema: type: boolean responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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-03 00:20:06.125000+00:00 ownerId: 57e281b5-ec5b-4701-80a0-92a936a68da3 updatedAt: 2015-02-03 00: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-27 20:56:02.125000+00:00 isApiConsumer: false total: 1 schema: type: object description: 'Response payload for listAllUsers.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: id: type: string description: 'The unique identifier of the resource.' username: type: string description: 'The username used to authenticate the user.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email email_verified_at: type: 'null' description: 'The date and time when the user''s email address was verified, in ISO 8601 format.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' type: type: string description: 'The type of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' organizationId: type: string description: 'The unique identifier of the organization.' organization: type: object description: 'The organization that owns the resource.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' properties: type: object description: 'Additional properties associated with the resource.' properties: defaultAccessManagementUi: type: string description: 'The Access Management UI variant the organization defaults to.' required: - defaultAccessManagementUi entitlements: type: object description: 'The features and capabilities the organization is entitled to use.' properties: createSubOrgs: type: boolean description: 'Whether the organization is allowed to create sub-organizations.' createEnvironments: type: boolean description: 'Whether the organization is allowed to create environments.' hybrid: type: object description: 'Whether hybrid deployments are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled hybridInsight: type: boolean description: 'Whether Hybrid Insight is available to the organization.' hybridAutoDiscoverProperties: type: boolean description: 'Whether hybrid runtimes can auto-discover platform properties.' globalDeployment: type: boolean description: 'Whether the entitlement allows global deployment of MuleSoft applications.' vCoresProduction: type: object description: 'Number of production vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresSandbox: type: object description: 'Number of sandbox vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresDesign: type: object description: 'Number of design-time vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned staticIps: type: object description: 'Number of static IPs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpcs: type: object description: 'Number of Anypoint VPCs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpns: type: object description: 'Number of VPN connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned networkConnections: type: object description: 'Number of network connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned workerLoggingOverride: type: object description: 'Whether the organization can override worker logging configuration.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled messaging: type: object description: 'Whether Anypoint MQ is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned mqMessages: type: object description: 'Number of Anypoint MQ messages included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqRequests: type: object description: 'Number of Anypoint MQ requests included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqAdvancedFeatures: type: object description: 'Whether Anypoint MQ advanced features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled objectStoreRequestUnits: type: object description: 'Number of Object Store request units included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn objectStoreKeys: type: object description: 'Number of Object Store keys included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn gateways: type: object description: 'Number of API gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned designCenter: type: object description: 'Whether Anypoint Design Center is available to the organization.' properties: mozart: type: boolean description: 'Whether MuleSoft Mozart is available to the organization.' api: type: boolean description: 'Per-API capacity included in the entitlement.' apiVisual: type: boolean description: 'Whether the visual API designer is available to the organization.' apiExample: type: boolean description: 'Whether API example projects are available to the organization.' required: - mozart - api - apiVisual - apiExample partnersProduction: type: object description: 'Whether production capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned partnersSandbox: type: object description: 'Whether sandbox capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersProduction: type: object description: 'Whether B2B Trading Partner Manager production capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersSandbox: type: object description: 'Whether B2B Trading Partner Manager sandbox capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned loadBalancer: type: object description: 'Number of dedicated load balancers available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned externalIdentity: type: boolean description: 'Whether the user belongs to an external identity provider.' autoscaling: type: boolean description: 'Whether deployment autoscaling is available to the organization.' armAlerts: type: boolean description: 'Whether Anypoint Runtime Manager alerts are available to the organization.' apis: type: object description: 'Per-API limits or counters defined for the entitlement.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiCatalog: type: object description: 'Whether the API catalog is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiMonitoring: type: object description: 'Whether API monitoring is available to the organization.' properties: schedules: type: integer description: 'Whether scheduled flows are available to the organization.' required: - schedules apiCommunityManager: type: object description: 'Whether Anypoint API Community Manager is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiExperienceHub: type: object description: 'Whether Anypoint API Experience Hub is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled monitoringCenter: type: object description: 'Whether Anypoint Monitoring Center is available to the organization.' properties: productSKU: type: integer description: 'The product SKU that identifies the entitlement.' rawStorageOverrideGB: type: integer description: 'Override for the raw storage allowance, in GB.' dataRegion: type: string description: 'The cloud region where data for this organization is stored.' productionUnits: type: integer description: 'Number of production units included in the entitlement.' preProductionUnits: type: integer description: 'Number of pre-production units included in the entitlement.' storageBase: type: integer description: 'Base storage allowance included with the entitlement, in GB.' storageAddOn: type: integer description: 'Additional storage capacity provisioned on top of the base allowance, in GB.' required: - productSKU - rawStorageOverrideGB - dataRegion - productionUnits - preProductionUnits - storageBase - storageAddOn apiQuery: type: object description: 'Whether API Query is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' productSKU: type: integer description: 'The product SKU that identifies the entitlement.' required: - enabled - productSKU apiQueryC360: type: object description: 'Whether API Query for Customer 360 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled rpa: type: object description: 'Whether MuleSoft RPA is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' active: type: boolean description: 'Whether the feature or resource is currently active.' composerVersion: type: string description: 'The version of MuleSoft Composer available to the organization.' required: - enabled - active - composerVersion idp: type: object description: 'Whether the organization can configure its own identity provider.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled AutomationCreditsDW: type: object description: 'Number of automation credits available to the organization in Data Warehouse units.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned apiGovernance: type: object description: 'Whether Anypoint API Governance is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' apisPerMonth: type: integer description: 'Number of APIs the organization is allowed to manage per month.' required: - enabled - apisPerMonth apiGovernanceDomain: type: object description: 'Whether the API Governance domain feature is available to the organization.' properties: domain: type: string description: 'The domain name associated with the organization.' required: - domain crowd: type: object description: 'Whether the Crowd developer experience is available to the organization.' properties: hideApiManagerDesigner: type: boolean description: 'Whether the legacy API Manager designer is hidden from the organization.' hideFormerApiPlatform: type: boolean description: 'Whether the former API Platform UI is hidden from the organization.' environments: type: boolean description: 'The environments configured for the organization.' required: - hideApiManagerDesigner - hideFormerApiPlatform - environments cam: type: object description: 'Whether Anypoint Connectivity Access Management (CAM) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled exchange2: type: object description: 'Whether Anypoint Exchange 2 features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' assetUsageAndEngagement: type: object description: 'Whether asset usage and engagement metrics are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - enabled - assetUsageAndEngagement crowdSelfServiceMigration: type: object description: 'Whether self-service migration to Crowd is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled kpiDashboard: type: object description: 'Whether the KPI dashboard is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled pcf: type: boolean description: 'Whether the Pivotal Cloud Foundry integration is available to the organization.' appViz: type: boolean description: 'Whether Anypoint Application Visualization is available to the organization.' workerClouds: type: object description: 'Whether MuleSoft worker clouds are available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned runtimeFabric: type: boolean description: 'Whether Anypoint Runtime Fabric is available to the organization.' runtimeFabricCloud: type: object description: 'Whether Anypoint Runtime Fabric (Cloud) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled serviceMesh: type: object description: 'Whether Anypoint Service Mesh is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled flexGateway: type: object description: 'Whether Anypoint Omni Gateway is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled managedGatewaySmall: type: object description: 'Number of small managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned managedGatewayLarge: type: object description: 'Number of large managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned rtfManagedGateway: type: object description: 'Number of Runtime Fabric managed gateways available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled composer: type: object description: 'Whether MuleSoft Composer is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' tasksPerMonth: type: integer description: 'Number of tasks the organization is allowed to run per month.' maxConnectors: type: integer description: 'Maximum number of connectors the organization is allowed to use.' unlimitedConnectors: type: boolean description: 'Whether the entitlement allows the use of an unlimited number of connectors.' isHyperAutomation: type: boolean description: 'Whether the entitlement applies to MuleSoft Hyperautomation.' required: - enabled - tasksPerMonth - maxConnectors - unlimitedConnectors - isHyperAutomation muleDxWebIde: type: object description: 'Whether the Mule DX web IDE is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxGenAI: type: object description: 'Whether Mule DX generative AI features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxEDA: type: object description: 'Whether Mule DX event-driven architecture features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled usageBasedPricing: type: object description: 'Whether usage-based pricing applies to the organization.' properties: muleRuntimeIntegration: type: object description: 'Whether Mule Runtime integration features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' flows: type: integer description: 'Flow-related limits associated with the entitlement.' messages: type: integer description: 'Per-message limits or counters defined for the entitlement.' throughput: type: integer description: 'Throughput limits defined for the entitlement.' required: - enabled - flows - messages - throughput required: - muleRuntimeIntegration usageBasedPricingLimits: type: object description: 'Limits that apply to the organization under usage-based pricing.' properties: cpu: type: object description: 'CPU resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra memory: type: object description: 'Memory resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra required: - cpu - memory highAvailability: type: object description: 'Whether the entitlement allows high-availability deployments.' properties: clustering: type: boolean description: 'Whether the entitlement allows clustered deployments.' required: - clustering cloudhub1: type: object description: 'Whether CloudHub 1.0 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled telemetryExporter: type: object description: 'Whether the telemetry exporter is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - createSubOrgs - createEnvironments - hybrid - hybridInsight - hybridAutoDiscoverProperties - globalDeployment - vCoresProduction - vCoresSandbox - vCoresDesign - staticIps - vpcs - vpns - networkConnections - workerLoggingOverride - messaging - mqMessages - mqRequests - mqAdvancedFeatures - objectStoreRequestUnits - objectStoreKeys - gateways - designCenter - partnersProduction - partnersSandbox - tradingPartnersProduction - tradingPartnersSandbox - loadBalancer - externalIdentity - autoscaling - armAlerts - apis - apiCatalog - apiMonitoring - apiCommunityManager - apiExperienceHub - monitoringCenter - apiQuery - apiQueryC360 - rpa - idp - AutomationCreditsDW - apiGovernance - apiGovernanceDomain - crowd - cam - exchange2 - crowdSelfServiceMigration - kpiDashboard - pcf - appViz - workerClouds - runtimeFabric - runtimeFabricCloud - serviceMesh - flexGateway - managedGatewaySmall - managedGatewayLarge - rtfManagedGateway - composer - muleDxWebIde - muleDxGenAI - muleDxEDA - usageBasedPricing - usageBasedPricingLimits - highAvailability - cloudhub1 - telemetryExporter isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: object tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration required: - name - id - createdAt - ownerId - updatedAt - clientId - domain - idprovider_id - properties - entitlements - isFederated - isRoot - isMaster - parentOrganizationIds - subOrganizationIds - tenantOrganizationIds - subscription isApiConsumer: type: boolean description: 'Whether the user has been granted API consumer access.' required: - id - username - firstName - lastName - email - email_verified_at - enabled - idprovider_id - type - createdAt - updatedAt - lastLogin - organizationId - organization - isApiConsumer total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List all users operationId: listAllUsers post: description: Creates new users responses: '201': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Create a user operationId: createUser put: description: Update a group of users requestBody: $ref: '#/components/requestBodies/Generated12' responses: '204': description: Success '400': description: Invalid data in body '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update multiple users operationId: updateAllUsers delete: description: Delete a group of users requestBody: $ref: '#/components/requestBodies/Generated10' responses: '204': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete multiple users operationId: deleteAllUsers /users/{userId}: description: A single user get: description: Returns a single user parameters: - $ref: '#/components/parameters/XOrigin_globalUserId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: id: 5197cdf3-36c9-4bcb-8840-5779e961c746 createdAt: 2015-01-29 00:00:53.315000+00:00 updatedAt: 2015-01-29 00:00:55.163000+00:00 lastLogin: 2015-01-29 00:11:55.163000+00:00 previousLastLogin: 2015-01-28 00:11:55.163000+00:00 firstName: Organization lastName: Owner ipAllowlistExcluded: false email: core_services@mulesoft.com email_verified_at: 2015-01-29 00: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-03 00:20:06.125000+00:00 ownerId: 57e281b5-ec5b-4701-80a0-92a936a68da3 updatedAt: 2015-02-03 00: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-27 20:56:02.125000+00:00 properties: {} schema: type: object description: 'Response payload for getUserById.' properties: id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' previousLastLogin: type: string description: 'The date and time of the user''s previous successful login, in ISO 8601 format.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' ipAllowlistExcluded: type: boolean description: 'Whether the resource is excluded from organization-level IP allowlist enforcement.' email: type: string description: 'The user''s email address.' format: email email_verified_at: type: string description: 'The date and time when the user''s email address was verified, in ISO 8601 format.' phoneNumber: type: string description: 'The user''s phone number.' username: type: string description: 'The username used to authenticate the user.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' deleted: type: boolean description: 'Whether the resource has been marked as deleted.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' organization: type: object description: 'The organization that owns the resource.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' properties: type: object description: 'Additional properties associated with the resource.' properties: defaultAccessManagementUi: type: string description: 'The Access Management UI variant the organization defaults to.' required: - defaultAccessManagementUi entitlements: type: object description: 'The features and capabilities the organization is entitled to use.' properties: createSubOrgs: type: boolean description: 'Whether the organization is allowed to create sub-organizations.' createEnvironments: type: boolean description: 'Whether the organization is allowed to create environments.' hybrid: type: object description: 'Whether hybrid deployments are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled hybridInsight: type: boolean description: 'Whether Hybrid Insight is available to the organization.' hybridAutoDiscoverProperties: type: boolean description: 'Whether hybrid runtimes can auto-discover platform properties.' globalDeployment: type: boolean description: 'Whether the entitlement allows global deployment of MuleSoft applications.' vCoresProduction: type: object description: 'Number of production vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresSandbox: type: object description: 'Number of sandbox vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresDesign: type: object description: 'Number of design-time vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned staticIps: type: object description: 'Number of static IPs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpcs: type: object description: 'Number of Anypoint VPCs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpns: type: object description: 'Number of VPN connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned networkConnections: type: object description: 'Number of network connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned workerLoggingOverride: type: object description: 'Whether the organization can override worker logging configuration.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled messaging: type: object description: 'Whether Anypoint MQ is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned mqMessages: type: object description: 'Number of Anypoint MQ messages included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqRequests: type: object description: 'Number of Anypoint MQ requests included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqAdvancedFeatures: type: object description: 'Whether Anypoint MQ advanced features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled objectStoreRequestUnits: type: object description: 'Number of Object Store request units included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn objectStoreKeys: type: object description: 'Number of Object Store keys included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn gateways: type: object description: 'Number of API gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned designCenter: type: object description: 'Whether Anypoint Design Center is available to the organization.' properties: mozart: type: boolean description: 'Whether MuleSoft Mozart is available to the organization.' api: type: boolean description: 'Per-API capacity included in the entitlement.' apiVisual: type: boolean description: 'Whether the visual API designer is available to the organization.' apiExample: type: boolean description: 'Whether API example projects are available to the organization.' required: - mozart - api - apiVisual - apiExample partnersProduction: type: object description: 'Whether production capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned partnersSandbox: type: object description: 'Whether sandbox capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersProduction: type: object description: 'Whether B2B Trading Partner Manager production capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersSandbox: type: object description: 'Whether B2B Trading Partner Manager sandbox capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned loadBalancer: type: object description: 'Number of dedicated load balancers available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned externalIdentity: type: boolean description: 'Whether the user belongs to an external identity provider.' autoscaling: type: boolean description: 'Whether deployment autoscaling is available to the organization.' armAlerts: type: boolean description: 'Whether Anypoint Runtime Manager alerts are available to the organization.' apis: type: object description: 'Per-API limits or counters defined for the entitlement.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiCatalog: type: object description: 'Whether the API catalog is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiMonitoring: type: object description: 'Whether API monitoring is available to the organization.' properties: schedules: type: integer description: 'Whether scheduled flows are available to the organization.' required: - schedules apiCommunityManager: type: object description: 'Whether Anypoint API Community Manager is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiExperienceHub: type: object description: 'Whether Anypoint API Experience Hub is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled monitoringCenter: type: object description: 'Whether Anypoint Monitoring Center is available to the organization.' properties: productSKU: type: integer description: 'The product SKU that identifies the entitlement.' rawStorageOverrideGB: type: integer description: 'Override for the raw storage allowance, in GB.' dataRegion: type: string description: 'The cloud region where data for this organization is stored.' productionUnits: type: integer description: 'Number of production units included in the entitlement.' preProductionUnits: type: integer description: 'Number of pre-production units included in the entitlement.' storageBase: type: integer description: 'Base storage allowance included with the entitlement, in GB.' storageAddOn: type: integer description: 'Additional storage capacity provisioned on top of the base allowance, in GB.' required: - productSKU - rawStorageOverrideGB - dataRegion - productionUnits - preProductionUnits - storageBase - storageAddOn apiQuery: type: object description: 'Whether API Query is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' productSKU: type: integer description: 'The product SKU that identifies the entitlement.' required: - enabled - productSKU apiQueryC360: type: object description: 'Whether API Query for Customer 360 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled rpa: type: object description: 'Whether MuleSoft RPA is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' active: type: boolean description: 'Whether the feature or resource is currently active.' composerVersion: type: string description: 'The version of MuleSoft Composer available to the organization.' required: - enabled - active - composerVersion idp: type: object description: 'Whether the organization can configure its own identity provider.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled AutomationCreditsDW: type: object description: 'Number of automation credits available to the organization in Data Warehouse units.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned apiGovernance: type: object description: 'Whether Anypoint API Governance is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' apisPerMonth: type: integer description: 'Number of APIs the organization is allowed to manage per month.' required: - enabled - apisPerMonth apiGovernanceDomain: type: object description: 'Whether the API Governance domain feature is available to the organization.' properties: domain: type: string description: 'The domain name associated with the organization.' required: - domain crowd: type: object description: 'Whether the Crowd developer experience is available to the organization.' properties: hideApiManagerDesigner: type: boolean description: 'Whether the legacy API Manager designer is hidden from the organization.' hideFormerApiPlatform: type: boolean description: 'Whether the former API Platform UI is hidden from the organization.' environments: type: boolean description: 'The environments configured for the organization.' required: - hideApiManagerDesigner - hideFormerApiPlatform - environments cam: type: object description: 'Whether Anypoint Connectivity Access Management (CAM) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled exchange2: type: object description: 'Whether Anypoint Exchange 2 features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' assetUsageAndEngagement: type: object description: 'Whether asset usage and engagement metrics are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - enabled - assetUsageAndEngagement crowdSelfServiceMigration: type: object description: 'Whether self-service migration to Crowd is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled kpiDashboard: type: object description: 'Whether the KPI dashboard is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled pcf: type: boolean description: 'Whether the Pivotal Cloud Foundry integration is available to the organization.' appViz: type: boolean description: 'Whether Anypoint Application Visualization is available to the organization.' workerClouds: type: object description: 'Whether MuleSoft worker clouds are available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned runtimeFabric: type: boolean description: 'Whether Anypoint Runtime Fabric is available to the organization.' runtimeFabricCloud: type: object description: 'Whether Anypoint Runtime Fabric (Cloud) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled serviceMesh: type: object description: 'Whether Anypoint Service Mesh is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled flexGateway: type: object description: 'Whether Anypoint Omni Gateway is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled managedGatewaySmall: type: object description: 'Number of small managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned managedGatewayLarge: type: object description: 'Number of large managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned rtfManagedGateway: type: object description: 'Number of Runtime Fabric managed gateways available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled composer: type: object description: 'Whether MuleSoft Composer is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' tasksPerMonth: type: integer description: 'Number of tasks the organization is allowed to run per month.' maxConnectors: type: integer description: 'Maximum number of connectors the organization is allowed to use.' unlimitedConnectors: type: boolean description: 'Whether the entitlement allows the use of an unlimited number of connectors.' isHyperAutomation: type: boolean description: 'Whether the entitlement applies to MuleSoft Hyperautomation.' required: - enabled - tasksPerMonth - maxConnectors - unlimitedConnectors - isHyperAutomation muleDxWebIde: type: object description: 'Whether the Mule DX web IDE is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxGenAI: type: object description: 'Whether Mule DX generative AI features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxEDA: type: object description: 'Whether Mule DX event-driven architecture features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled usageBasedPricing: type: object description: 'Whether usage-based pricing applies to the organization.' properties: muleRuntimeIntegration: type: object description: 'Whether Mule Runtime integration features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' flows: type: integer description: 'Flow-related limits associated with the entitlement.' messages: type: integer description: 'Per-message limits or counters defined for the entitlement.' throughput: type: integer description: 'Throughput limits defined for the entitlement.' required: - enabled - flows - messages - throughput required: - muleRuntimeIntegration usageBasedPricingLimits: type: object description: 'Limits that apply to the organization under usage-based pricing.' properties: cpu: type: object description: 'CPU resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra memory: type: object description: 'Memory resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra required: - cpu - memory highAvailability: type: object description: 'Whether the entitlement allows high-availability deployments.' properties: clustering: type: boolean description: 'Whether the entitlement allows clustered deployments.' required: - clustering cloudhub1: type: object description: 'Whether CloudHub 1.0 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled telemetryExporter: type: object description: 'Whether the telemetry exporter is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - createSubOrgs - createEnvironments - hybrid - hybridInsight - hybridAutoDiscoverProperties - globalDeployment - vCoresProduction - vCoresSandbox - vCoresDesign - staticIps - vpcs - vpns - networkConnections - workerLoggingOverride - messaging - mqMessages - mqRequests - mqAdvancedFeatures - objectStoreRequestUnits - objectStoreKeys - gateways - designCenter - partnersProduction - partnersSandbox - tradingPartnersProduction - tradingPartnersSandbox - loadBalancer - externalIdentity - autoscaling - armAlerts - apis - apiCatalog - apiMonitoring - apiCommunityManager - apiExperienceHub - monitoringCenter - apiQuery - apiQueryC360 - rpa - idp - AutomationCreditsDW - apiGovernance - apiGovernanceDomain - crowd - cam - exchange2 - crowdSelfServiceMigration - kpiDashboard - pcf - appViz - workerClouds - runtimeFabric - runtimeFabricCloud - serviceMesh - flexGateway - managedGatewaySmall - managedGatewayLarge - rtfManagedGateway - composer - muleDxWebIde - muleDxGenAI - muleDxEDA - usageBasedPricing - usageBasedPricingLimits - highAvailability - cloudhub1 - telemetryExporter isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: object tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration required: - name - id - createdAt - ownerId - updatedAt - clientId - domain - idprovider_id - properties - entitlements - isFederated - isRoot - isMaster - parentOrganizationIds - subOrganizationIds - tenantOrganizationIds - subscription properties: type: object description: 'Additional properties associated with the resource.' properties: {} required: - id - createdAt - updatedAt - lastLogin - previousLastLogin - firstName - lastName - ipAllowlistExcluded - email - email_verified_at - phoneNumber - username - enabled - deleted - idprovider_id - organization - properties '404': description: User does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get a user by ID operationId: getUserById put: description: Updates a single user. Modifying email may require reauthentication. parameters: - $ref: '#/components/parameters/XOrigin_globalUserId_Path' requestBody: $ref: '#/components/requestBodies/Generated4' responses: '200': description: Success '302': description: Reauthentication required. '400': description: Invalid data in body '403': description: Reauthentication required. See location link x-amf-mediaType: application/json content: application/json: example: error: You must reauthenticate location: /login/?reauthenticate=true schema: type: object description: 'Response payload for updateUserById.' properties: error: type: string description: 'Error information returned with the response.' location: type: string description: 'The geographic location associated with the resource.' required: - error - location '404': description: User does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update a user by ID operationId: updateUserById delete: description: Deletes a user parameters: - $ref: '#/components/parameters/XOrigin_globalUserId_Path' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete a user by ID operationId: deleteUserById /users/{userId}/banpassword: description: Ban a user's current password post: description: 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 parameters: - $ref: '#/components/parameters/XOrigin_globalUserId_Path' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Ban a user password operationId: createUsersBanpassword /users/{userId}/properties: description: Properties of a user put: description: Update the properties of a user parameters: - $ref: '#/components/parameters/XOrigin_globalUserId_Path' requestBody: $ref: '#/components/requestBodies/Generated13' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: cs_auth: activeOrganizationId: f0c9b011-980e-4928-9430-e60e3a97c043 schema: type: object description: 'Response payload for updateUserProperties.' properties: cs_auth: type: object description: 'Configuration for Anypoint Platform authentication settings.' properties: activeOrganizationId: type: string description: 'The unique identifier of the organization currently active in the user''s session.' required: - activeOrganizationId required: - cs_auth '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update user properties operationId: updateUserProperties /users/{userId}/roles: description: Roles assigned to the user get: description: Returns a list of roles assigned to the user parameters: - name: namepace description: return only role assignments where a role contains a permission that is part of the given namespace required: false in: query schema: type: string - name: role_groups description: get user roles from role_groups required: false in: query schema: type: boolean - name: teams description: get team roles from team_role_assignments required: false in: query schema: type: boolean - $ref: '#/components/parameters/XOrigin_globalUserId_Path' x-amf-queryParameters: role_id: description: return only role assignments containing one of the supplied role_ids required: false anyOf: - type: string - items: type: string namespaces: description: return only role assignments where a role belongs to the given namespace required: false anyOf: - type: string - items: type: string responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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 schema: type: object description: 'Response payload for listAllUserRoles.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: role_id: type: string description: 'The unique identifier of the role.' context_params: type: object description: 'Additional parameters that scope the operation to a specific organization or environment.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' required: - org name: type: string description: 'The display name of the resource.' description: type: string description: 'A human-readable description of the resource.' required: - role_id - context_params - name - description total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List roles assigned to a user operationId: listAllUserRoles /users/{userId}/roles/{roleId}: description: A role assigned to the user post: description: Assign a role to the user parameters: - $ref: '#/components/parameters/XOrigin_globalUserId_Path' - $ref: '#/components/parameters/XOrigin_globalUserRoleId_Path' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Assign a role to a user operationId: addRoleToUser delete: description: Unassign a role from the user parameters: - $ref: '#/components/parameters/XOrigin_globalUserId_Path' - $ref: '#/components/parameters/XOrigin_globalUserRoleId_Path' responses: '200': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Unassign a role from a user operationId: removeRoleFromUser /users/me: get: description: Returns the user bound to the provided access token responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: id: 5197cdf3-36c9-4bcb-8840-5779e961c746 createdAt: 2015-01-29 00:00:53.315000+00:00 updatedAt: 2015-01-29 00:00:55.163000+00:00 lastLogin: 2015-01-29 00:11:55.163000+00:00 previousLastLogin: 2015-01-28 00:11:55.163000+00:00 firstName: Organization lastName: Owner ipAllowlistExcluded: false email: core_services@mulesoft.com email_verified_at: 2015-01-29 00: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-03 00:20:06.125000+00:00 ownerId: 57e281b5-ec5b-4701-80a0-92a936a68da3 updatedAt: 2015-02-03 00: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-27 20:56:02.125000+00:00 properties: {} schema: type: object description: 'Response payload for listUsersMe.' properties: id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' previousLastLogin: type: string description: 'The date and time of the user''s previous successful login, in ISO 8601 format.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' ipAllowlistExcluded: type: boolean description: 'Whether the resource is excluded from organization-level IP allowlist enforcement.' email: type: string description: 'The user''s email address.' format: email email_verified_at: type: string description: 'The date and time when the user''s email address was verified, in ISO 8601 format.' phoneNumber: type: string description: 'The user''s phone number.' username: type: string description: 'The username used to authenticate the user.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' deleted: type: boolean description: 'Whether the resource has been marked as deleted.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' organization: type: object description: 'The organization that owns the resource.' properties: name: type: string description: 'The display name of the resource.' id: type: string description: 'The unique identifier of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' ownerId: type: string description: 'The unique identifier of the user who owns the resource.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' clientId: type: string description: 'The unique identifier of the client application.' domain: type: string description: 'The domain name associated with the organization.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' properties: type: object description: 'Additional properties associated with the resource.' properties: defaultAccessManagementUi: type: string description: 'The Access Management UI variant the organization defaults to.' required: - defaultAccessManagementUi entitlements: type: object description: 'The features and capabilities the organization is entitled to use.' properties: createSubOrgs: type: boolean description: 'Whether the organization is allowed to create sub-organizations.' createEnvironments: type: boolean description: 'Whether the organization is allowed to create environments.' hybrid: type: object description: 'Whether hybrid deployments are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled hybridInsight: type: boolean description: 'Whether Hybrid Insight is available to the organization.' hybridAutoDiscoverProperties: type: boolean description: 'Whether hybrid runtimes can auto-discover platform properties.' globalDeployment: type: boolean description: 'Whether the entitlement allows global deployment of MuleSoft applications.' vCoresProduction: type: object description: 'Number of production vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresSandbox: type: object description: 'Number of sandbox vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vCoresDesign: type: object description: 'Number of design-time vCores included in the entitlement.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned staticIps: type: object description: 'Number of static IPs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpcs: type: object description: 'Number of Anypoint VPCs available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned vpns: type: object description: 'Number of VPN connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned networkConnections: type: object description: 'Number of network connections available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned workerLoggingOverride: type: object description: 'Whether the organization can override worker logging configuration.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled messaging: type: object description: 'Whether Anypoint MQ is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned mqMessages: type: object description: 'Number of Anypoint MQ messages included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqRequests: type: object description: 'Number of Anypoint MQ requests included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn mqAdvancedFeatures: type: object description: 'Whether Anypoint MQ advanced features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled objectStoreRequestUnits: type: object description: 'Number of Object Store request units included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn objectStoreKeys: type: object description: 'Number of Object Store keys included in the entitlement.' properties: base: type: integer description: 'The base allowance included with the entitlement.' addOn: type: integer description: 'Additional capacity provisioned on top of the base allowance.' required: - base - addOn gateways: type: object description: 'Number of API gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned designCenter: type: object description: 'Whether Anypoint Design Center is available to the organization.' properties: mozart: type: boolean description: 'Whether MuleSoft Mozart is available to the organization.' api: type: boolean description: 'Per-API capacity included in the entitlement.' apiVisual: type: boolean description: 'Whether the visual API designer is available to the organization.' apiExample: type: boolean description: 'Whether API example projects are available to the organization.' required: - mozart - api - apiVisual - apiExample partnersProduction: type: object description: 'Whether production capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned partnersSandbox: type: object description: 'Whether sandbox capacity for partner-managed APIs is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersProduction: type: object description: 'Whether B2B Trading Partner Manager production capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned tradingPartnersSandbox: type: object description: 'Whether B2B Trading Partner Manager sandbox capacity is available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned loadBalancer: type: object description: 'Number of dedicated load balancers available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned externalIdentity: type: boolean description: 'Whether the user belongs to an external identity provider.' autoscaling: type: boolean description: 'Whether deployment autoscaling is available to the organization.' armAlerts: type: boolean description: 'Whether Anypoint Runtime Manager alerts are available to the organization.' apis: type: object description: 'Per-API limits or counters defined for the entitlement.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiCatalog: type: object description: 'Whether the API catalog is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiMonitoring: type: object description: 'Whether API monitoring is available to the organization.' properties: schedules: type: integer description: 'Whether scheduled flows are available to the organization.' required: - schedules apiCommunityManager: type: object description: 'Whether Anypoint API Community Manager is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled apiExperienceHub: type: object description: 'Whether Anypoint API Experience Hub is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled monitoringCenter: type: object description: 'Whether Anypoint Monitoring Center is available to the organization.' properties: productSKU: type: integer description: 'The product SKU that identifies the entitlement.' rawStorageOverrideGB: type: integer description: 'Override for the raw storage allowance, in GB.' dataRegion: type: string description: 'The cloud region where data for this organization is stored.' productionUnits: type: integer description: 'Number of production units included in the entitlement.' preProductionUnits: type: integer description: 'Number of pre-production units included in the entitlement.' storageBase: type: integer description: 'Base storage allowance included with the entitlement, in GB.' storageAddOn: type: integer description: 'Additional storage capacity provisioned on top of the base allowance, in GB.' required: - productSKU - rawStorageOverrideGB - dataRegion - productionUnits - preProductionUnits - storageBase - storageAddOn apiQuery: type: object description: 'Whether API Query is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' productSKU: type: integer description: 'The product SKU that identifies the entitlement.' required: - enabled - productSKU apiQueryC360: type: object description: 'Whether API Query for Customer 360 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled rpa: type: object description: 'Whether MuleSoft RPA is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' active: type: boolean description: 'Whether the feature or resource is currently active.' composerVersion: type: string description: 'The version of MuleSoft Composer available to the organization.' required: - enabled - active - composerVersion idp: type: object description: 'Whether the organization can configure its own identity provider.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled AutomationCreditsDW: type: object description: 'Number of automation credits available to the organization in Data Warehouse units.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' required: - assigned apiGovernance: type: object description: 'Whether Anypoint API Governance is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' apisPerMonth: type: integer description: 'Number of APIs the organization is allowed to manage per month.' required: - enabled - apisPerMonth apiGovernanceDomain: type: object description: 'Whether the API Governance domain feature is available to the organization.' properties: domain: type: string description: 'The domain name associated with the organization.' required: - domain crowd: type: object description: 'Whether the Crowd developer experience is available to the organization.' properties: hideApiManagerDesigner: type: boolean description: 'Whether the legacy API Manager designer is hidden from the organization.' hideFormerApiPlatform: type: boolean description: 'Whether the former API Platform UI is hidden from the organization.' environments: type: boolean description: 'The environments configured for the organization.' required: - hideApiManagerDesigner - hideFormerApiPlatform - environments cam: type: object description: 'Whether Anypoint Connectivity Access Management (CAM) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled exchange2: type: object description: 'Whether Anypoint Exchange 2 features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' assetUsageAndEngagement: type: object description: 'Whether asset usage and engagement metrics are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - enabled - assetUsageAndEngagement crowdSelfServiceMigration: type: object description: 'Whether self-service migration to Crowd is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled kpiDashboard: type: object description: 'Whether the KPI dashboard is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled pcf: type: boolean description: 'Whether the Pivotal Cloud Foundry integration is available to the organization.' appViz: type: boolean description: 'Whether Anypoint Application Visualization is available to the organization.' workerClouds: type: object description: 'Whether MuleSoft worker clouds are available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned runtimeFabric: type: boolean description: 'Whether Anypoint Runtime Fabric is available to the organization.' runtimeFabricCloud: type: object description: 'Whether Anypoint Runtime Fabric (Cloud) is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled serviceMesh: type: object description: 'Whether Anypoint Service Mesh is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled flexGateway: type: object description: 'Whether Anypoint Omni Gateway is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled managedGatewaySmall: type: object description: 'Number of small managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned managedGatewayLarge: type: object description: 'Number of large managed gateways available to the organization.' properties: assigned: type: integer description: 'Whether the role or team has been assigned to the user or client.' reassigned: type: integer description: 'Whether the role or team has been reassigned to a different scope.' required: - assigned - reassigned rtfManagedGateway: type: object description: 'Number of Runtime Fabric managed gateways available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled composer: type: object description: 'Whether MuleSoft Composer is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' tasksPerMonth: type: integer description: 'Number of tasks the organization is allowed to run per month.' maxConnectors: type: integer description: 'Maximum number of connectors the organization is allowed to use.' unlimitedConnectors: type: boolean description: 'Whether the entitlement allows the use of an unlimited number of connectors.' isHyperAutomation: type: boolean description: 'Whether the entitlement applies to MuleSoft Hyperautomation.' required: - enabled - tasksPerMonth - maxConnectors - unlimitedConnectors - isHyperAutomation muleDxWebIde: type: object description: 'Whether the Mule DX web IDE is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxGenAI: type: object description: 'Whether Mule DX generative AI features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled muleDxEDA: type: object description: 'Whether Mule DX event-driven architecture features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled usageBasedPricing: type: object description: 'Whether usage-based pricing applies to the organization.' properties: muleRuntimeIntegration: type: object description: 'Whether Mule Runtime integration features are available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' flows: type: integer description: 'Flow-related limits associated with the entitlement.' messages: type: integer description: 'Per-message limits or counters defined for the entitlement.' throughput: type: integer description: 'Throughput limits defined for the entitlement.' required: - enabled - flows - messages - throughput required: - muleRuntimeIntegration usageBasedPricingLimits: type: object description: 'Limits that apply to the organization under usage-based pricing.' properties: cpu: type: object description: 'CPU resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra memory: type: object description: 'Memory resource limits or reservations associated with the entitlement.' properties: base: type: number description: 'The base allowance included with the entitlement.' extra: type: number description: 'Additional information returned with the response.' required: - base - extra required: - cpu - memory highAvailability: type: object description: 'Whether the entitlement allows high-availability deployments.' properties: clustering: type: boolean description: 'Whether the entitlement allows clustered deployments.' required: - clustering cloudhub1: type: object description: 'Whether CloudHub 1.0 is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled telemetryExporter: type: object description: 'Whether the telemetry exporter is available to the organization.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled required: - createSubOrgs - createEnvironments - hybrid - hybridInsight - hybridAutoDiscoverProperties - globalDeployment - vCoresProduction - vCoresSandbox - vCoresDesign - staticIps - vpcs - vpns - networkConnections - workerLoggingOverride - messaging - mqMessages - mqRequests - mqAdvancedFeatures - objectStoreRequestUnits - objectStoreKeys - gateways - designCenter - partnersProduction - partnersSandbox - tradingPartnersProduction - tradingPartnersSandbox - loadBalancer - externalIdentity - autoscaling - armAlerts - apis - apiCatalog - apiMonitoring - apiCommunityManager - apiExperienceHub - monitoringCenter - apiQuery - apiQueryC360 - rpa - idp - AutomationCreditsDW - apiGovernance - apiGovernanceDomain - crowd - cam - exchange2 - crowdSelfServiceMigration - kpiDashboard - pcf - appViz - workerClouds - runtimeFabric - runtimeFabricCloud - serviceMesh - flexGateway - managedGatewaySmall - managedGatewayLarge - rtfManagedGateway - composer - muleDxWebIde - muleDxGenAI - muleDxEDA - usageBasedPricing - usageBasedPricingLimits - highAvailability - cloudhub1 - telemetryExporter isFederated: type: boolean description: 'Whether the organization uses a federated identity provider for authentication.' isRoot: type: boolean description: 'Whether the organization is the root organization in the hierarchy.' isMaster: type: boolean description: 'Whether the organization is the master organization.' parentOrganizationIds: type: array description: 'Identifiers of the organizations that are ancestors of this organization in the hierarchy.' items: type: object subOrganizationIds: type: array description: 'Identifiers of the organizations that are direct children of this organization.' items: type: object tenantOrganizationIds: type: array description: 'Identifiers of the tenant organizations associated with this organization.' items: type: object subscription: type: object description: 'The subscription that controls the entitlements available to the organization.' properties: category: type: string description: 'The category that classifies the resource.' type: type: string description: 'The type of the resource.' expiration: type: string description: 'The expiration date and time of the resource, in ISO 8601 format.' required: - category - type - expiration required: - name - id - createdAt - ownerId - updatedAt - clientId - domain - idprovider_id - properties - entitlements - isFederated - isRoot - isMaster - parentOrganizationIds - subOrganizationIds - tenantOrganizationIds - subscription properties: type: object description: 'Additional properties associated with the resource.' properties: {} required: - id - createdAt - updatedAt - lastLogin - previousLastLogin - firstName - lastName - ipAllowlistExcluded - email - email_verified_at - phoneNumber - username - enabled - deleted - idprovider_id - organization - properties '401': description: Unauthorized. There is no user attached to the token '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get user for access token operationId: listUsersMe /version: description: Application version get: description: Retrieve the version info for the application x-optionalSecurity: true responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: branch: HEAD tag: 0.3.8-alpha.2 short: 72fe9aa long: 72fe9aadcdeec52ef117a0abe6473329ad31cad3 environment: production schema: type: object description: 'Response payload for listVersion.' properties: branch: type: string description: 'The source-control branch associated with the resource.' tag: type: string description: 'The source-control tag associated with the resource.' short: type: string description: 'The short form of the value.' long: type: string description: 'The long form of the value.' environment: type: string description: 'The environment associated with the resource.' required: - branch - tag - short - long - environment '404': description: Version information could not be gathered (likely a filesystem error). See logs for details. '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - {} summary: Get application version info operationId: listVersion /v2: {} /v2/oauth2: {} /v2/oauth2/authorize: get: description: Starts an OAuth2 authorization flow; allows the logged-in user to authorize 3rd-party access to their data parameters: - name: client_id description: The ID of the application attempting to be authorized required: false in: query schema: type: string - name: scope description: Space-delimited list of scopes the client is requesting required: false in: query schema: type: string - name: state description: a parameter with a string that will be supplied in a redirect back to the application upon success required: false in: query schema: type: string - name: redirect_uri description: Redirect uri for the application's authorization callback required: false in: query schema: type: string - name: response_type description: describes the type of object that the application wishes to receive upon success required: false in: query schema: type: string - name: nonce description: value used to mitigate replay attacks required: false in: query schema: type: string responses: '302': description: '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 ' '400': description: Bad request; an invalid redirect_uri, response_type or client_id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Start v2 OAuth2 authorization operationId: listV2Oauth2Authorize post: description: Starts an OAuth2 authorization flow; allows the logged-in user to authorize 3rd-party access to their data requestBody: $ref: '#/components/requestBodies/Generated' responses: '302': description: 'Redirects the user to the application''s callback URI if the application is already authorized Redirects the user to the consent screen otherwise ' '400': description: Bad request; an invalid redirect_uri, response_type or client_id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Post v2 OAuth2 authorization operationId: createV2Oauth2Authorize /v2/oauth2/authorize/{domain}: description: OAuth2 authorization route for federated or non-federated users get: description: Starts an OAuth2 authorization flow; allows the logged-in user to authorize 3rd-party access to their data parameters: - name: nonce description: value used to mitigate replay attacks required: false in: query schema: type: string - name: state description: a parameter with a string that will be supplied in a redirect back to the application upon success required: false in: query schema: type: string - name: scope description: Space-delimited list of scopes the client is requesting required: false in: query schema: type: string - name: redirect_uri description: Redirect uri for the application's authorization callback required: false in: query schema: type: string - name: client_id description: The ID of the application attempting to be authorized required: false in: query schema: type: string - name: response_type description: describes the type of object that the application wishes to receive upon success required: false in: query schema: type: string - name: domain description: Domain name to identify the organization to identify what identity management system needs to authentication the user. required: true in: path schema: type: string responses: '302': description: '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 ' '400': description: Bad request; an invalid redirect_uri, response_type or client_id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Start v2 OAuth2 flow by domain operationId: listV2Oauth2AuthorizeByDomain post: description: Starts an OAuth2 authorization flow; allows the logged-in user to authorize 3rd-party access to their data parameters: - name: domain description: Domain name to identify the organization to identify what identity management system needs to authentication the user. required: true in: path schema: type: string requestBody: $ref: '#/components/requestBodies/Generated' responses: '302': description: 'Redirects the user to the application''s callback URI if the application is already authorized Redirects the user to the consent screen otherwise ' '400': description: Bad request; an invalid redirect_uri, response_type or client_id '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Post v2 OAuth2 flow by domain operationId: createV2Oauth2AuthorizeByDomain /v2/oauth2/decision: post: description: Confirms whether a user grants consent to a 3rd-party application responses: '302': description: Redirects the user to the application's callback URI security: - bearerAuth: [] - clientAuth: [] summary: Record v2 OAuth2 consent decision operationId: createV2Oauth2Decision /v2/oauth2/token: post: description: Allows 3rd-party applications to receive tokens via a variety of supported grant types responses: '200': description: '' security: - bearerAuth: [] - clientAuth: [] summary: Create v2 OAuth2 token operationId: createV2Oauth2Token /v2/oauth2/keys: get: description: Public JWK Set used to sign OpenID Connect id_tokens responses: '200': description: 'A JWK Set containing one or more JWK-formatted keys. For more information about the JWK format, see RFC-7517 For more information about the use of JWKs in OpenID Connect, see the OpenID Connect Core 1.0 spec ' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get v2 OAuth2 public JWK set operationId: listV2Oauth2Keys /v2/oauth2/.well-known/openid-configuration: get: description: OpenID Connect Discovery Configuration responses: '200': description: 'The service''s OpenID Provider Configuration Information metadata document. For more information about the contents and use of the document, see the OpenID Connect Discovery 1.0 spec ' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get OpenID Connect configuration operationId: getOpenidConfiguration /v2/oauth2/userinfo: get: description: OpenID Connect Userinfo endpoint. responses: '200': description: 'A set of claims about the authenticated End-User. For more information about the use of the userinfo endpoint in OpenID Connect, see the OpenID Connect Core 1.0 spec ' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get v2 OpenID Connect userinfo operationId: listV2Oauth2Userinfo post: description: OpenID Connect Userinfo endpoint. responses: '200': description: 'A set of claims about the authenticated End-User. For more information about the use of the userinfo endpoint in OpenID Connect, see the OpenID Connect Core 1.0 spec ' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Post v2 OpenID Connect userinfo operationId: createV2Oauth2Userinfo /v2/oauth2/introspect: post: description: Introspect an access token or refresh token requestBody: content: application/x-www-form-urlencoded: schema: type: object required: - token properties: token: description: The token to introspect type: string token_type_hint: description: A hint about the type of the token submitted for introspection default: access_token enum: - access_token - refresh_token type: string x-amf-mediaType: application/x-www-form-urlencoded description: Request payload for create v2 oauth2 introspect. responses: '200': description: '' security: - basic: [] summary: Introspect v2 OAuth2 token operationId: createV2Oauth2Introspect /v2/oauth2/revoke: post: description: Revoke an access token or a refresh token requestBody: content: application/x-www-form-urlencoded: schema: type: object required: - token properties: token: description: The token to revoke type: string token_type_hint: description: A hint about the type of the token submitted for revocation default: access_token enum: - access_token - refresh_token type: string x-amf-mediaType: application/x-www-form-urlencoded description: Request payload for create v2 oauth2 revoke. responses: '200': description: Token was revoked successfully '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Revoke v2 OAuth2 token operationId: createV2Oauth2Revoke /v2/organizations: description: Organizations /v2/organizations/{organizationId}: description: A single organization get: parameters: - $ref: '#/components/parameters/XOrigin_v2OrganizationId_Path' x-amf-queryParameters: include?: description: attributes to include as part of response anyOf: - type: string - items: type: any responses: '200': description: '' x-amf-mediaType: application/json content: application/json: schema: $ref: '#/components/schemas/Organization' '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get v2 organization operationId: getV2Organization description: Retrieves details of v2. delete: parameters: - name: force description: If true, safety validations should be ignored in: query schema: type: boolean default: false - $ref: '#/components/parameters/XOrigin_v2OrganizationId_Path' responses: '204': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete v2 organization operationId: deleteV2Organization description: Deletes an existing v2. /v2/organizations/{organizationId}/einstein: parameters: - $ref: '#/components/parameters/XOrigin_v2OrganizationId_Path' /v2/organizations/{organizationId}/einstein/status: get: description: Get the org-wide Einstein status parameters: - $ref: '#/components/parameters/XOrigin_v2OrganizationId_Path' responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: enabled: true schema: type: object description: 'Response payload for listV2EinsteinStatus.' properties: enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - enabled '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get org Einstein status operationId: listV2EinsteinStatus put: description: Set the org-wide Einstein status parameters: - $ref: '#/components/parameters/XOrigin_v2OrganizationId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/SetOrgWideEinsteinStatusRequest' x-amf-mediaType: application/json description: Request payload for update v2 einstein status. responses: '204': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Set org Einstein status operationId: updateV2EinsteinStatus /v2/organizations/{organizationId}/einstein/termsAndConditions: get: description: Get the agreement status for einstein terms and conditions parameters: - $ref: '#/components/parameters/XOrigin_v2OrganizationId_Path' responses: '200': description: Returns agreement status x-amf-mediaType: application/json content: application/json: example: status: ok schema: type: object description: 'Response payload for listV2EinsteinTermsAndConditions.' properties: status: type: string description: 'The current status of the resource.' required: - status '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get Einstein terms and conditions status operationId: listV2EinsteinTermsAndConditions put: description: Toggle the agreement status for einstein terms and conditions parameters: - $ref: '#/components/parameters/XOrigin_v2OrganizationId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutEinsteinTermsAndConditionsRequest' x-amf-mediaType: application/json description: Request payload for update v2 einstein terms and conditions. responses: '204': description: Success '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Set Einstein terms and conditions status operationId: updateV2EinsteinTermsAndConditions /v2/organizations/{organizationId}/entitlements: get: parameters: - $ref: '#/components/parameters/XOrigin_v2OrganizationId_Path' responses: '200': description: Return entitlements for this organization x-amf-mediaType: application/json content: application/json: schema: type: object example: 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 security: - bearerAuth: [] - clientAuth: [] summary: List v2 entitlements operationId: listV2Entitlements description: Retrieves a list of v2 entitlements. put: description: Sets one or more values for entitlements parameters: - $ref: '#/components/parameters/XOrigin_v2OrganizationId_Path' requestBody: content: application/json: schema: $ref: '#/components/schemas/Entitlements' x-amf-mediaType: application/json description: Request payload for update v2 entitlements. responses: '200': description: Entitlement has been modified x-amf-mediaType: application/json content: application/json: schema: type: object example: 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 '404': description: Resource does not exist '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Update v2 entitlements operationId: updateV2Entitlements /v2/organizations/{organizationId}/entitlements/{entitlementName}: get: description: Returns the name and value of the specified entitlement parameters: - $ref: '#/components/parameters/XOrigin_v2OrganizationId_Path' - name: entitlementName description: The name of the entitlement required: true in: path schema: type: string responses: '200': description: Returns entitlement x-amf-mediaType: application/json content: application/json: schema: type: object example: createEnvironments: true '404': description: Resource does not exists '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Get a v2 entitlement operationId: getV2Entitlements /v2/organizations/{organizationId}/environments: parameters: - $ref: '#/components/parameters/XOrigin_v2OrganizationId_Path' /v2/organizations/{organizationId}/environments/{environmentId}: delete: description: Delete an environment parameters: - $ref: '#/components/parameters/XOrigin_v2OrganizationId_Path' - name: environmentId required: true in: path schema: type: string description: The unique identifier of the environment. x-origin: - api: urn:api:access-management operation: listEnvironments description: GET `/organizations/{organizationId}/environments`; use each `data[].id` value as an environment identifier. values: $.data[*].id labels: $.data[*].name responses: '204': description: Successful. Returns zero length body '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: Delete a v2 environment operationId: deleteV2Environments /v2/roles: {} /v2/roles/users: description: Users by role V2 get: description: Retrieve users by roles parameters: - name: role_groups description: Flag that indicates if we should include role groups assignments when looking for the role required: true in: query schema: type: boolean default: false - name: teams description: Flag that indicates if we should include team role assignments when looking for the role required: true in: query schema: type: boolean default: false responses: '200': description: Success x-amf-mediaType: application/json content: application/json: example: 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-21 11: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-21 11:11:48.204521-07:00 total: 1 schema: type: object description: 'Response payload for listV2RolesUsers.' properties: data: type: array description: 'The list of items returned by the request.' items: type: object description: 'The list of items returned by the request.' properties: id: type: string description: 'The unique identifier of the resource.' username: type: string description: 'The username used to authenticate the user.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' idprovider_id: type: string description: 'The unique identifier of the identity provider.' type: type: string description: 'The type of the resource.' createdAt: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' updatedAt: type: string description: 'The date and time when the resource was last updated, in ISO 8601 format.' lastLogin: type: string description: 'The date and time of the user''s most recent successful login, in ISO 8601 format.' organizationId: type: string description: 'The unique identifier of the organization.' assignments: type: array description: 'The role and team assignments associated with the user or client.' items: type: object description: 'The role and team assignments associated with the user or client.' properties: role_id: type: string description: 'The unique identifier of the role.' context_params: type: object description: 'Additional parameters that scope the operation to a specific organization or environment.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' user: type: string description: 'The user associated with the resource.' required: - org - user created_at: type: string description: 'The date and time when the resource was created, in ISO 8601 format.' required: - role_id - context_params - created_at required: - id - username - firstName - lastName - email - enabled - idprovider_id - type - createdAt - updatedAt - lastLogin - organizationId - assignments total: type: integer description: 'The total number of items available across all pages.' required: - data - total '429': description: Too many requests headers: X-RateLimit-Limit: description: The maximum number of requests you're permitted to make in the rate limit window. schema: type: number X-RateLimit-Remaining: description: The number of requests remaining in the current rate limit window. schema: type: number X-RateLimit-Reset: description: The time at which the current rate limit window resets in UTC epoch seconds. schema: type: number security: - bearerAuth: [] - clientAuth: [] summary: List v2 users by role operationId: listV2RolesUsers components: requestBodies: Generated: content: application/x-www-form-urlencoded: schema: type: object properties: client_id: description: The ID of the application attempting to be authorized example: 3f7eb03b-1e53-4dd7-8304-c7f52cef183d type: string scope: description: Space-delimited list of scopes the client is requesting example: openid api:admin type: string state: description: a parameter with a string that will be supplied in a redirect back to the application upon success type: string redirect_uri: description: Redirect uri for the application's authorization callback type: string response_type: description: describes the type of object that the application wishes to receive upon success type: string nonce: description: value used to mitigate replay attacks type: string x-amf-mediaType: application/x-www-form-urlencoded description: OAuth authorization request with client credentials, scope, and redirect information. InviteNewList: content: application/json: schema: $ref: '#/components/schemas/InviteNewList' x-amf-mediaType: application/json description: List of new user invitations to send to the organization. InvitesIds: content: application/json: schema: $ref: '#/components/schemas/InvitesIds' x-amf-mediaType: application/json description: List of invite IDs to act upon (e.g., resend or cancel). Generated2: content: application/json: example: org: 68ef9520-24e9-4cf2-b2f5-620025690913 envId: 11152f65-b6fc-4de6-872e-5d03cdc79c89 schema: type: object description: 'Request payload for Generated2.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' envId: type: string description: 'The unique identifier of the environment.' required: - org - envId x-amf-mediaType: application/json description: Organization and environment context identifiers. Generated3: content: application/json: example: org: ms env: test schema: type: object description: 'Request payload for Generated3.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' env: type: string description: 'The environment slug or short identifier used in API paths.' required: - org - env x-amf-mediaType: application/json description: Organization and environment name identifiers. TeamExternalGroupMappingList: content: application/json: schema: $ref: '#/components/schemas/TeamExternalGroupMappingList' x-amf-mediaType: application/json description: List of external group mappings to associate with a team. Generated4: content: application/json: example: firstName: Juan lastName: Ferrer ipAllowlistExcluded: true email: jferrer@mulesoft.com phoneNumber: 111-111-1111 enabled: true properties: cs_auth: country: Argentina schema: type: object description: 'Request payload for Generated4.' properties: firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' ipAllowlistExcluded: type: boolean description: 'Whether the resource is excluded from organization-level IP allowlist enforcement.' email: type: string description: 'The user''s email address.' format: email phoneNumber: type: string description: 'The user''s phone number.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' properties: type: object description: 'Additional properties associated with the resource.' properties: cs_auth: type: object description: 'Configuration for Anypoint Platform authentication settings.' properties: country: type: string description: 'The country associated with the resource, as an ISO 3166-1 alpha-2 code.' required: - country required: - cs_auth required: - firstName - lastName - ipAllowlistExcluded - email - phoneNumber - enabled - properties x-amf-mediaType: application/json description: User profile data including name, email, phone, and properties. ConnectedApplicationSettingsWhitelist: content: application/json: schema: $ref: '#/components/schemas/ConnectedApplicationSettingsWhitelist' x-amf-mediaType: application/json description: Whitelist settings for connected application access control (deprecated, use allowlist). ConnectedApplicationSettingsAllowlist: content: application/json: schema: $ref: '#/components/schemas/ConnectedApplicationSettingsAllowlist' x-amf-mediaType: application/json description: Allowlist settings for connected application access control. ConnectedApplicationCreate: content: application/json: schema: $ref: '#/components/schemas/ConnectedApplicationCreate' x-amf-mediaType: application/json description: Configuration for creating a new connected application (OAuth client). ClientProviderClient: content: application/json: schema: $ref: '#/components/schemas/ClientProviderClient' x-amf-mediaType: application/json description: Client configuration for an external client identity provider. Generated5: content: application/json: example: 20460a62-bbdc-469d-9330-5eec892abd05: org: ms env: test 20460a62-bbdc-469d-9660-5eec892abd05: org: ms env: dev schema: type: object description: 'Request payload for Generated5.' properties: 20460a62-bbdc-469d-9330-5eec892abd05: type: object description: 'Per-resource entry keyed by identifier.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' env: type: string description: 'The environment slug or short identifier used in API paths.' required: - org - env 20460a62-bbdc-469d-9660-5eec892abd05: type: object description: 'Per-resource entry keyed by identifier.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' env: type: string description: 'The environment slug or short identifier used in API paths.' required: - org - env required: - 20460a62-bbdc-469d-9330-5eec892abd05 - 20460a62-bbdc-469d-9660-5eec892abd05 x-amf-mediaType: application/json description: Mapping of IDs to organization and environment pairs for bulk context assignment. Generated6: content: application/json: example: 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 schema: type: object description: 'Request payload for Generated6.' properties: client_id: type: string description: 'The unique identifier of the client application.' client_secret: type: string description: 'The client secret used to authenticate the application when requesting tokens.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - client_secret - name - redirect_uris - grant_types - properties - org_id x-amf-mediaType: application/json description: OAuth client registration data with credentials, grant types, and redirect URIs. Generated7: content: application/json: example: 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 schema: type: object description: 'Request payload for Generated7.' properties: client_id: type: string description: 'The unique identifier of the client application.' name: type: string description: 'The display name of the resource.' redirect_uris: type: array description: 'The redirect URIs the user is sent to after authorization completes.' items: type: string description: 'The redirect URIs the user is sent to after authorization completes.' format: uri grant_types: type: array description: 'The OAuth 2.0 grant types supported by the application.' items: type: string description: 'The OAuth 2.0 grant types supported by the application.' properties: type: object description: 'Additional properties associated with the resource.' properties: additional: type: string description: 'Supplementary information returned with the response.' required: - additional org_id: type: string description: 'The unique identifier of the organization.' required: - client_id - name - redirect_uris - grant_types - properties - org_id x-amf-mediaType: application/json description: OAuth client update data with name, grant types, and redirect URIs. ConnectedApplicationUpdate: content: application/json: schema: $ref: '#/components/schemas/ConnectedApplicationUpdate' x-amf-mediaType: application/json description: Updated configuration for an existing connected application. Generated8: content: application/json: schema: type: object additionalProperties: false required: - scopes properties: scopes: type: array minItems: 1 items: type: object additionalProperties: false required: - scope - context_params properties: scope: type: string minLength: 1 maxLength: 255 context_params: type: object maxProperties: 2 example: scopes: - scope: example:scope context_params: org: 8b0b657c-91ca-420d-870a-08699094f5e4 envId: 7cc0463b-f7be-418d-8a64-84fbad13ab00 x-amf-mediaType: application/json description: List of scopes with context parameters to assign to a connected application. Generated9: content: application/json: schema: type: object additionalProperties: false required: - scopes properties: scopes: type: array minItems: 1 items: type: object additionalProperties: false required: - scope - context_params properties: scope: type: string minLength: 1 maxLength: 255 context_params: type: object maxProperties: 7 scopesToDelete: type: array minItems: 1 items: type: object additionalProperties: false required: - scope - context_params properties: scope: type: string minLength: 1 maxLength: 255 context_params: type: object maxProperties: 7 example: 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 x-amf-mediaType: application/json description: Scopes to add and remove from a connected application in a single request. ExternalClientProvider: content: application/json: schema: $ref: '#/components/schemas/ExternalClientProvider' x-amf-mediaType: application/json description: Configuration for an external client identity provider including endpoints and credentials. Generated10: content: application/json: example: - 1c0d1a43-4d91-4b52-bcc6-cff8ecf0c3a3 - dc52bf66-b0d8-4cda-9ae8-45a5f085ead4 - 5314c476-1cd4-49be-ba4e-1d67f6c052c3 schema: type: array description: 'Request payload for Generated10.' items: type: string description: 'Request payload for Generated10.' x-amf-mediaType: application/json description: Request payload for Generated10 operations. Generated11: content: application/json: example: - role_id: d74ef94a-4292-4896-b860-b05bd7f90d6d context_params: org: 68ef9520-24e9-4cf2-b2f5-620025690913 schema: type: array description: 'Request payload for Generated11.' items: type: object description: 'Request payload for Generated11.' properties: role_id: type: string description: 'The unique identifier of the role.' context_params: type: object description: 'Additional parameters that scope the operation to a specific organization or environment.' properties: org: type: string description: 'The organization slug or short identifier used in API paths.' required: - org required: - role_id - context_params x-amf-mediaType: application/json description: Request payload for Generated11 operations. RoleAssignmentCollectionRequest: content: application/json: schema: $ref: '#/components/schemas/RoleAssignmentCollectionRequest' x-amf-mediaType: application/json description: Request payload for role assignment collection request operations. Generated12: content: application/json: example: - 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 schema: type: array description: 'Request payload for Generated12.' items: type: object description: 'Request payload for Generated12.' properties: id: type: string description: 'The unique identifier of the resource.' firstName: type: string description: 'The user''s first name.' lastName: type: string description: 'The user''s last name.' email: type: string description: 'The user''s email address.' format: email phoneNumber: type: string description: 'The user''s phone number.' enabled: type: boolean description: 'Whether the feature or resource is currently enabled.' required: - id - firstName - lastName - email - phoneNumber - enabled x-amf-mediaType: application/json description: Request payload for Generated12 operations. Generated13: content: application/json: example: cs_auth: activeOrganizationId: f0c9b011-980e-4928-9430-e60e3a97c043 schema: type: object description: 'Response payload for createRecoverUsername.' properties: cs_auth: type: object description: 'Configuration for Anypoint Platform authentication settings.' properties: activeOrganizationId: type: string description: 'The unique identifier of the organization currently active in the user''s session.' required: - activeOrganizationId required: - cs_auth x-amf-mediaType: application/json description: Request payload for Generated13 operations. securitySchemes: oauth_2_0_raml_1_0: type: oauth2 description: 'OAuth2 is a protocol that lets external apps request authorization to private details in a user''s account without getting their password. This is preferred over Basic Authentication because tokens can be limited to specific types of data, and can be revoked by users at any time. Use apiportal for the client_id ' x-amf-describedBy: headers: Authorization: description: Used to send a valid OAuth 2 access token. type: string responses: '401': description: Unauthorized (Invalid OAuth2 access token ) body: {} x-amf-settings: authorizationGrants: - authorization_code - implicit - client_credentials - password flows: authorizationCode: authorizationUrl: https://anypoint.mulesoft.com/accounts/oauth2/authorize tokenUrl: https://anypoint.mulesoft.com/accounts/oauth2/token scopes: '*': '' basic: type: http description: This endpoint supports Basic Authentication. scheme: basic bearerAuth: type: http scheme: bearer bearerFormat: JWT description: Bearer token authentication for API access. clientAuth: type: http scheme: bearer description: Client credentials authentication token. schemas: AuthorizeContext: example: namespace: cloudhub actions: - GET resourceTemplates: - /organizations/{{org}}/environments/{{envId}}/applications offset: 0 limit: 50 type: object additionalProperties: true required: - namespace - resourceTemplates properties: namespace: description: the namespace for the resources defined in the resource template type: string actions: description: which actions to return results for. If not provided, results for all actions are returned. type: array maxItems: 10 minItems: 1 items: type: string resourceTemplates: description: a resource string template. Named context parameters must be wrapped in double-curly braces. e.g. /organizations/{{org}}/environments/{{envId}}/applications type: array maxItems: 5 minItems: 1 items: type: string simplify: description: whether to reduce the result set by removing individual contexts that are permitted from contexts that match all values. default: false type: boolean limit: description: return a maximum of this many results type: integer offset: description: return results starting at this position default: 0 type: integer AuthorizeContextResult: type: object additionalProperties: false required: - namespace - resource - resourceTemplate - resourceTemplateParams - actions properties: namespace: description: the namespace for the resources sent in the request type: string resource: description: the resource string for this result with context parameters placed in the requested resource template type: string resourceTemplate: description: the original provided resource template that matches this result type: string resourceTemplateParams: description: context parameter conditions that matched the template for the set of actions type: object minProperties: 0 maxProperties: 7 patternProperties: ^.*$: type: string minLength: 1 maxLength: 255 actions: description: the subset of requested actions that the principal is allowed to do on this resource. type: array maxItems: 10 minItems: 1 items: type: string stringOrArray: oneOf: - type: string - type: array items: type: string ConnectedApplicationCreate: example: 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 type: object additionalProperties: false required: - redirect_uris properties: grant_types: description: The grant types to be used with this app type: array minItems: 1 items: enum: - implicit - authorization_code - refresh_token - client_credentials - password - urn:ietf:params:oauth:grant-type:jwt-bearer type: string client_name: $ref: '#/components/schemas/StringField' enabled: type: boolean owner_user_id: description: 'Send owner_user_id: null to create an Ownerless Connected App. Otherwise, it will default to the caller''s ID. ' type: string minLength: 1 maxLength: 255 generate_iss_claim_without_token: type: boolean public_keys: type: array items: type: string minLength: 1 maxLength: 4096 client_secret: $ref: '#/components/schemas/StringField' client_id: $ref: '#/components/schemas/StringField' tos_uri: $ref: '#/components/schemas/StringField' scopes: description: The level of permissions to provide to the app type: array items: type: string minLength: 1 client_uri: $ref: '#/components/schemas/StringField' redirect_uris: description: Configure which URIs users should be directed to after authorization type: array items: type: string minLength: 1 owner_org_id: description: '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. ' type: string minLength: 1 maxLength: 255 audience: description: Configure whether the app is internal to your company or is a third-party public app that can be distributed outside of your organization enum: - everyone - internal type: string policy_uri: $ref: '#/components/schemas/StringField' ConnectedApplicationUpdate: example: client_name: SampleClient redirect_uris: - https://localhost:3000/callback - https://example.com/auth-callback grant_types: - implicit - authorization_code type: object additionalProperties: false properties: client_id: $ref: '#/components/schemas/StringField' client_name: $ref: '#/components/schemas/StringField' client_secret: $ref: '#/components/schemas/StringField' owner_org_id: $ref: '#/components/schemas/StringField' owner_user_id: description: '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. ' type: string minLength: 1 maxLength: 255 enabled: type: boolean audience: description: Configure whether the app is internal to your company or is a third-party public app that can be distributed outside of your organization enum: - everyone - internal type: string client_uri: $ref: '#/components/schemas/StringField' policy_uri: $ref: '#/components/schemas/StringField' tos_uri: $ref: '#/components/schemas/StringField' public_keys: type: array items: type: string minLength: 1 maxLength: 4096 grant_types: description: The grant types to be used with this app type: array minItems: 1 items: enum: - implicit - authorization_code - refresh_token - client_credentials - password - urn:ietf:params:oauth:grant-type:jwt-bearer type: string redirect_uris: description: Configure which URIs users should be directed to after authorization type: array items: type: string minLength: 1 scopes: description: The level of permissions to provide to the app type: array items: type: string minLength: 1 generate_iss_claim_without_token: type: boolean FeatureFlagCheckOrgList: example: - 83e8126e-0369-46de-9da5-c9410bfa7ac5 - e8f5a3e4-0840-4dd8-b812-976afc39000a type: array items: $ref: '#/components/schemas/uuid' Invite: example: id: 520 code: f2e8dfab-6699-4889-831f-6dc6f8428cb0 invited_at: 2015-01-30 22: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-10 22:23:55.433000+00:00 status: INVITED completed_at: null completed_by_user: null teams: - team_name: IT team_id: f59632be-e43f-4c4f-a303-36b8b0623f29 membership_type: member x-amf-union: - $ref: '#/components/schemas/InviteRoleGroups' - $ref: '#/components/schemas/InviteTeams' - $ref: '#/components/schemas/InviteRoles' InviteNewList: example: teams: - email: christopher.mordue@mulesoft.com teams: - team_id: f59632be-e43f-4c4f-a303-36b8b0623f29 membership_type: member roles: - email: lshanmugavel@mulesoft.com roles: - role_id: 674c9f7a-ee81-44d7-b25f-eb938d8ebaa1 context_params: org: f0c9b011-980e-4928-9430-e60e3a97c043 x-amf-union: - $ref: '#/components/schemas/InviteNewRoleGroups' - $ref: '#/components/schemas/InviteNewTeams' - $ref: '#/components/schemas/InviteNewRoles' InviteList: example: - id: 520 code: f2e8dfab-6699-4889-831f-6dc6f8428cb0 invited_at: 2015-01-30 22: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-10 22: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 type: array items: $ref: '#/components/schemas/Invite' InvitesIds: example: - 520 type: array items: type: integer InvitesResendResponse: example: succeeded: - 520 failed: [] type: object additionalProperties: false required: - succeeded - failed properties: succeeded: type: array items: type: integer failed: type: array items: type: integer ExternalClientProvidersFind: type: object required: - providerId - organizationId - name - type properties: providerId: type: string organizationId: type: string name: type: string type: type: object required: - name properties: description: type: string name: enum: - ping - openam - openid-dynamic-client type: string version: type: string ExternalClientProvider: example: example_0: name: Production Client Management Config type: description: PingFederate name: ping allow_untrusted_certificates: true oauth2_authorization_provider: urls: authorize: https://example.com/as/authorization.oauth2 oauth2_token_provider: urls: create: https:/example.com/as/token.oauth2 oauth2_token_validation_provider: urls: validate: https://example.com/as/token.oauth2 client_id: c123985a07a64c08ad7a12738a954471 client_secret: '********' token_mapping: username: username email: email firstName: firstName lastName: lastName user: user oauth2_client_provider: urls: create: https://example.com/pf-ws/rest/oauth/clients delete: https://example.com/pf-ws/rest/oauth/clients/{{client_id}} username: max.mule password: '********' grant_types: - name: password label: Resource Owner Grant required: false exclude: [] depends: [] - name: implicit label: Implicit Grant required: false exclude: [] depends: [] - name: client_credentials label: Client Credentials Grant required: false exclude: [] depends: [] - name: authorization_code label: Authorization Code Grant required: false exclude: [] depends: [] - name: refresh_token label: Refresh Token required: false exclude: [] depends: - authorization_code - password bypass_approval_page: false send_credentials_in_header: false example_1: providerId: 2e71d283-6248-4c81-98eb-e254a89b7e0a organizationId: 2e50e859-0042-46ff-8cf8-1ad6f0c78b67 name: Production Client Management Config type: description: PingFederate name: ping allow_untrusted_certificates: true oauth2_authorization_provider: urls: authorize: https://example.com/as/authorization.oauth2 oauth2_token_provider: urls: create: https:/example.com/as/token.oauth2 oauth2_token_validation_provider: urls: validate: https://example.com/as/token.oauth2 client_id: c123985a07a64c08ad7a12738a954471 client_secret: '********' token_mapping: username: username email: email firstName: firstName lastName: lastName user: user oauth2_client_provider: urls: create: https://example.com/pf-ws/rest/oauth/clients delete: https://example.com/pf-ws/rest/oauth/clients/{{client_id}} username: max.mule password: '********' grant_types: - name: password label: Resource Owner Grant required: false exclude: [] depends: [] - name: implicit label: Implicit Grant required: false exclude: [] depends: [] - name: client_credentials label: Client Credentials Grant required: false exclude: [] depends: [] - name: authorization_code label: Authorization Code Grant required: false exclude: [] depends: [] - name: refresh_token label: Refresh Token required: false exclude: [] depends: - authorization_code - password bypass_approval_page: false send_credentials_in_header: false x-amf-union: - $ref: '#/components/schemas/OpenAMProvider' - $ref: '#/components/schemas/PingFederateProvider' - $ref: '#/components/schemas/OIDCDynamicClientProvider' ExternalClientProviderOptional: example: name: Production Client Management Config type: description: PingFederate allow_untrusted_certificates: true oauth2_authorization_provider: urls: authorize: https://example.com/as/authorization.oauth2 oauth2_token_provider: urls: create: https:/example.com/as/token.oauth2 oauth2_token_validation_provider: urls: validate: https://example.com/as/token.oauth2 client_id: c123985a07a64c08ad7a12738a954471 client_secret: '********' token_mapping: username: username email: email firstName: firstName lastName: lastName user: user oauth2_client_provider: urls: create: https://example.com/pf-ws/rest/oauth/clients delete: https://example.com/pf-ws/rest/oauth/clients/{{client_id}} username: max.mule password: '********' grant_types: - name: password label: Resource Owner Grant required: false exclude: [] depends: [] - name: implicit label: Implicit Grant required: false exclude: [] depends: [] - name: client_credentials label: Client Credentials Grant required: false exclude: [] depends: [] - name: authorization_code label: Authorization Code Grant required: false exclude: [] depends: [] - name: refresh_token label: Refresh Token required: false exclude: [] depends: - authorization_code - password bypass_approval_page: false send_credentials_in_header: false x-amf-union: - $ref: '#/components/schemas/OpenAMProviderOptional' - $ref: '#/components/schemas/PingFederateProviderOptional' - $ref: '#/components/schemas/OIDCDynamicClientProviderOptional' clientProvidersTypeAndGrantTypes: example: type: description: PingFederate name: ping grant_types: - name: password label: Resource Owner Grant required: false exclude: [] depends: [] - name: implicit label: Implicit Grant required: false exclude: [] depends: [] - name: client_credentials label: Client Credentials Grant required: false exclude: [] depends: [] - name: authorization_code label: Authorization Code Grant required: false exclude: [] depends: [] - name: refresh_token label: Refresh Token required: false exclude: [] depends: - authorization_code - password type: object additionalProperties: false required: - type - grant_types properties: type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - ping - openam - openid-dynamic-client type: string version: type: string grant_types: type: array items: $ref: '#/components/schemas/GrantType' ClientProviderClient: example: 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 type: object additionalProperties: false properties: client_name: type: string minLength: 1 maxLength: 255 client_id: type: string minLength: 1 maxLength: 255 client_secret: type: string minLength: 10 maxLength: 255 grant_types: type: array items: type: string minLength: 1 redirect_uris: type: array items: type: string minLength: 1 OrgClientsSearch: example: client_id: - client1 - client2 type: object additionalProperties: false properties: name: $ref: '#/components/schemas/IdString' client_id: type: array items: $ref: '#/components/schemas/IdString' client_management_provider_id: type: array items: $ref: '#/components/schemas/uuid' OrgClientValidate: example: client_id: client1 client_secret: secret1 type: object additionalProperties: false required: - client_id properties: client_id: type: string minLength: 1 maxLength: 255 client_secret: type: string minLength: 1 maxLength: 255 UserAuthorization: example: authorization_id: '231245124' created_at: 2018-01-26 22:39:02.312000+00:00 updated_at: 2018-01-26 22:39:02.312000+00:00 last_used: 2018-01-26 22: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 type: object required: - authorization_id - created_at - updated_at - last_used - user_id - client_id - scopes properties: authorization_id: description: The ID of the authorization object type: string created_at: description: The time the authorization was created type: string format: date-time updated_at: description: The time the authorization was last modified type: string format: date-time last_used: description: The time the authorization was last used in an OAuth2 flow type: string format: date-time user_id: description: The ID of the user who granted the authorization type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ client_id: description: The ID of the client who is granted the authorization type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ scopes: description: The list of OAuth2 scopes contained in the authorization type: array items: type: string ConnectedApplicationSettings: example: whitelist_enabled: false applications_enabled: partial grant_types_allowed: - implicit - client_credentials - refresh_token whitelist_internal_applications: true type: object required: - applications_enabled - grant_types_allowed properties: whitelist_enabled: description: '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. ' type: boolean allowlist_enabled: description: '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. ' type: boolean applications_enabled: description: '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 ' enum: - none - partial - all type: string grant_types_allowed: description: The list of all grant types the Organization allows clients to use type: array items: type: string whitelist_internal_applications: description: '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. ' type: boolean allowlist_internal_applications: description: '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. ' type: boolean ConnectedApplicationSettingsUpdate: example: whitelist_enabled: false applications_enabled: partial grant_types_allowed: - implicit - client_credentials - refresh_token whitelist_internal_applications: true whitelist: - client_id: cba8d24f-8e6b-4615-9bb8-bc5a2c9933cd as_id: anypoint type: object required: - grant_types_allowed - applications_enabled properties: grant_types_allowed: description: The list of all grant types the Organization allows clients to use type: array items: type: string whitelist_enabled: description: '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. ' type: boolean whitelist: description: A set of entries to upsert into to the allowlist. type: array items: $ref: '#/components/schemas/ConnectedApplicationSettingsWhitelistEntry' import_existing_authorizations: description: If true, add all existing client authorizations to the allowlist with their registered scopes type: boolean whitelist_internal_applications: description: '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. ' type: boolean allowlist_internal_applications: description: '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. ' type: boolean allowlist_enabled: description: '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. ' type: boolean applications_enabled: description: '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 ' enum: - none - partial - all type: string ConnectedApplicationSettingsAllowlistEntry: type: object required: - client_id properties: client_id: description: The ID of the client that is allowlisted type: string authorized_scopes: description: 'The scopes the allowlisted client may request. If not provided, it defaults to the full set of scopes the client is registered to request. ' type: array items: type: string ConnectedApplicationSettingsAllowlist: example: - client_id: cf89d2b1-0f5f-4ef3-b70e-0954118d111f authorized_scopes: - openid - offline_access - read:organization type: array items: $ref: '#/components/schemas/ConnectedApplicationSettingsAllowlistEntry' ConnectedApplicationSettingsWhitelistEntry: type: object required: - client_id properties: client_id: description: The ID of the client that is allowlisted type: string authorized_scopes: description: 'The scopes the allowlisted client may request. If not provided, it defaults to the full set of scopes the client is registered to request. ' type: array items: type: string ConnectedApplicationSettingsWhitelist: example: - client_id: cf89d2b1-0f5f-4ef3-b70e-0954118d111f authorized_scopes: - openid - offline_access - read:organization type: array items: $ref: '#/components/schemas/ConnectedApplicationSettingsWhitelistEntry' EnvironmentClientProviders: example: suggestedClientManagementProviderIds: - 6a57bf06-9124-11e9-bc42-526af7764f64 type: object additionalProperties: false required: - suggestedClientManagementProviderIds properties: suggestedClientManagementProviderIds: type: array items: $ref: '#/components/schemas/uuid' FeatureFlagNew: example: enabled: false context: limit: 125 type: object additionalProperties: true required: - enabled properties: context: type: object enabled: type: boolean ExternalIdentityProvidersFind: type: object additionalProperties: false required: - provider_id - org_id - name - type properties: provider_id: type: string org_id: type: string name: type: string type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - ldap - openid - saml type: string ExternalIdentityProvider: example: name: Primary Identity Management Config type: description: SAML 2.0 name: saml service_provider: urls: sign_on: https://example.com/idp/login sign_out: https://example.com/idp/logout saml: audience: example.anypoint.mulesoft.com issuer: https://example.com public_key: - '-----BEGIN CERTIFICATE----- MIID4DCCA8igAwIBAgIOAXD1Vx9oAAAAAE8I+UMwDQYJKoZIhvcNAQELBQAwgaEx ORA3BgNVBAMMMFNlbGZTaWduZWRDZXJTZWxmU2lnbmVkQ2VydF8xOU1hcjIwMjB0 XzE5TWFyMjAyMDEYMBYGA1UECwwPMDBEZjQwMDAwNDNBVjZmMRcwFQYDVQQKDA5T YWxlc2ZvcmNlLmNvbTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbZELMAkGA1UECAwC Q0ExDDAKBgNVBAYTA1VTQTAeFw0yMDAzMjAwMDI4MTJaFw0yMTAzMjAwMDAwMDBa MIGhMTkwNwYDVQQDDDBTZWxmU2lnbmVkQ2VyU2VsZlNpZ25lZENlcnRfMTlNYXIy MDIwdF8xOU1hcjIwMjAxGDAWBgNVBAsMDzAwRGY0MDAwMDAzQVY2ZjEXMBUGA1UE CgwOU2FsZXNmb3JjZS5jb20xFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xCzAJBgNV BAgMAkNBMQwwCgYDVQQGEwNVU0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK AoIBAQCe/YnyilbiG6ptsIQu4V+Oe+hAMNYeBHh9JvnihAYe4z679KVJLpY+rE3N XK+JbZRDCUVewlSj+QhfvykzvJyXUrPC2NyrshW9DFUB36JbOBIYQL00s4TNEBTt z/LgDuVn0B7p5uk1HfeL6Ycul3XmAss913XRRMBmdTwi6vK+sVr4rTfzoFxyg7vS AAxDfrZh0mgieuVUENGXmV1OEKuX4G4WIeTwsOz0woHbNXM1M7Q1F9zLJK93QrpS Og0n3oAFyk9KAQ/Gv3AW12N5VlUAc+/NttRkO9k+ZhDllZSDWQSYokRbrxXurske 22Tp+rxr80lGFqDyb6bTem1c8s8jAgMBAAGjggESMIIBDjAdBgNVHQ4EFgQUM50l bdnhkFhJAcf/28trPacGk18wDwYDVR0TAQH/BAUwAwEB/zCB2wYDVR0jBIHTMIHQ gBQznSVt2eGQWEkBx//by2s9pwaTX6GBp6SBpDCBoTE5MDcGA1UEAwwwU2VsZlNp Z25lZENlclNlbGZTaWduZWRDZXJ0XzE5TWFyMjAyMHRfMTlNYXIyMDIwMRgwFgYD VQQLDA8wMERmNDAwMDAwM0FWNmYxFzAVBgNVBAoMDlNhbGVzZm9yY2UuY29tMRYw FAYDVQQHDA1TYW4gRnJhbmNpc2NvMQswCQYDVQQIDAJDQTEMMAoGA1UEBhMDVVNB gg4BcPVXH2gAAAAATwj5QzANBgkqhkiG9w0BAQsFAAOCAQEANEupbkT3hHAP0iXR 7TUNxYBi5y/TeMHE7SfRboMZpjLKMRiRCpCjSl2KlZp+wmGpGBfRiL1fPmiDOiPp 3XyWcJ5+xPL5btQhcnD+YsMcFLsKIIbCtqS0NXUWa1K4oRq2z4/EBrXZLtniQ+8M oQnXYvH5zKkpjH1JM8BDfceymgrYsdXmu3rflXuvxBLsDMDdk0zTojL1rIqzxTPH S2iabxwLeVWQEGPtXmRtS+kP6CY1pNoYbAFrJzZf4wakx95vwTqSXfcIoFdHUG5B X6db+brGnxVgv4mL8ZbxljYhcNDMyNm6kGoPqEyhGHhDTnQyn1RKcStBxkDXPIL3 b6ojYg== -----END CERTIFICATE-----' claims_mapping: group_attribute: memberOf sp_initiated_sso_enabled: false idp_initiated_sso_enabled: true require_encrypted_saml_assertions: false x-amf-union: - $ref: '#/components/schemas/SAMLProvider' - $ref: '#/components/schemas/LDAPProvider' - $ref: '#/components/schemas/OpenIDProviderManual' - $ref: '#/components/schemas/OpenIDProviderDynamic' ExternalIdentityProviderPostResponse: example: name: Primary Identity Management Config provider_id: 2e71d283-6248-4c81-98eb-e254a89b7e0a type: description: SAML 2.0 name: saml service_provider: urls: sign_on: https://example.com/idp/login sign_out: https://example.com/idp/logout saml: audience: example.anypoint.mulesoft.com issuer: https://example.com public_key: - '-----BEGIN CERTIFICATE----- MIID4DCCA8igAwIBAgIOAXD1Vx9oAAAAAE8I+UMwDQYJKoZIhvcNAQELBQAwgaEx ORA3BgNVBAMMMFNlbGZTaWduZWRDZXJTZWxmU2lnbmVkQ2VydF8xOU1hcjIwMjB0 XzE5TWFyMjAyMDEYMBYGA1UECwwPMDBEZjQwMDAwNDNBVjZmMRcwFQYDVQQKDA5T YWxlc2ZvcmNlLmNvbTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbZELMAkGA1UECAwC Q0ExDDAKBgNVBAYTA1VTQTAeFw0yMDAzMjAwMDI4MTJaFw0yMTAzMjAwMDAwMDBa MIGhMTkwNwYDVQQDDDBTZWxmU2lnbmVkQ2VyU2VsZlNpZ25lZENlcnRfMTlNYXIy MDIwdF8xOU1hcjIwMjAxGDAWBgNVBAsMDzAwRGY0MDAwMDAzQVY2ZjEXMBUGA1UE CgwOU2FsZXNmb3JjZS5jb20xFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xCzAJBgNV BAgMAkNBMQwwCgYDVQQGEwNVU0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK AoIBAQCe/YnyilbiG6ptsIQu4V+Oe+hAMNYeBHh9JvnihAYe4z679KVJLpY+rE3N XK+JbZRDCUVewlSj+QhfvykzvJyXUrPC2NyrshW9DFUB36JbOBIYQL00s4TNEBTt z/LgDuVn0B7p5uk1HfeL6Ycul3XmAss913XRRMBmdTwi6vK+sVr4rTfzoFxyg7vS AAxDfrZh0mgieuVUENGXmV1OEKuX4G4WIeTwsOz0woHbNXM1M7Q1F9zLJK93QrpS Og0n3oAFyk9KAQ/Gv3AW12N5VlUAc+/NttRkO9k+ZhDllZSDWQSYokRbrxXurske 22Tp+rxr80lGFqDyb6bTem1c8s8jAgMBAAGjggESMIIBDjAdBgNVHQ4EFgQUM50l bdnhkFhJAcf/28trPacGk18wDwYDVR0TAQH/BAUwAwEB/zCB2wYDVR0jBIHTMIHQ gBQznSVt2eGQWEkBx//by2s9pwaTX6GBp6SBpDCBoTE5MDcGA1UEAwwwU2VsZlNp Z25lZENlclNlbGZTaWduZWRDZXJ0XzE5TWFyMjAyMHRfMTlNYXIyMDIwMRgwFgYD VQQLDA8wMERmNDAwMDAwM0FWNmYxFzAVBgNVBAoMDlNhbGVzZm9yY2UuY29tMRYw FAYDVQQHDA1TYW4gRnJhbmNpc2NvMQswCQYDVQQIDAJDQTEMMAoGA1UEBhMDVVNB gg4BcPVXH2gAAAAATwj5QzANBgkqhkiG9w0BAQsFAAOCAQEANEupbkT3hHAP0iXR 7TUNxYBi5y/TeMHE7SfRboMZpjLKMRiRCpCjSl2KlZp+wmGpGBfRiL1fPmiDOiPp 3XyWcJ5+xPL5btQhcnD+YsMcFLsKIIbCtqS0NXUWa1K4oRq2z4/EBrXZLtniQ+8M oQnXYvH5zKkpjH1JM8BDfceymgrYsdXmu3rflXuvxBLsDMDdk0zTojL1rIqzxTPH S2iabxwLeVWQEGPtXmRtS+kP6CY1pNoYbAFrJzZf4wakx95vwTqSXfcIoFdHUG5B X6db+brGnxVgv4mL8ZbxljYhcNDMyNm6kGoPqEyhGHhDTnQyn1RKcStBxkDXPIL3 b6ojYg== -----END CERTIFICATE-----' claims_mapping: group_attribute: memberOf sp_initiated_sso_enabled: false idp_initiated_sso_enabled: true require_encrypted_saml_assertions: false x-amf-union: - $ref: '#/components/schemas/SAMLProviderPostResponse' - $ref: '#/components/schemas/LDAPProviderPostResponse' - $ref: '#/components/schemas/OpenIDProviderManualPostResponse' - $ref: '#/components/schemas/OpenIDProviderDynamicPostResponse' LDAPProviderTest: example: name: Test LDAP Connection type: name: ldap description: LDAP connection: binddn: cn=foo,dc=example,dc=com connectTimeoutSeconds: 60 host: ldap://some-ldap-host.example.com operationTimeoutMs: 60000 password: result.defaultPassword port: 3389 search_bases: group: ou=groups,dc=example,dc=com user: ou=people,dc=example,dc=com dns: group: cn={{groupName}},ou=groups,dc=example,dc=com user: uid={{username}},ou=people,dc=example,dc=com filters: groupsByUsername: (&(objectClass=groupOfUniqueNames)(uniqueMember=uid={{username}},ou=people,dc=example,dc=com)) userByUsername: (&(objectClass=inetOrgPerson)(uid={{username}})) user_mapping: email: mail firstName: givenName id: entryUUID lastName: sn username: uid group_mapping: groupName: cn id: entryUUID test_connection: username: Test123 password: '' type: object additionalProperties: false required: - type - connection - search_bases - dns - filters - user_mapping - group_mapping - test_connection properties: name: type: string type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - ldap type: string connection: type: object additionalProperties: false required: - binddn - connectTimeoutSeconds - host - operationTimeoutMs - port properties: binddn: type: string connectTimeoutSeconds: type: number host: type: string operationTimeoutMs: type: number password: type: string port: type: number validatecert: type: boolean search_bases: type: object additionalProperties: false required: - group - user properties: group: type: string user: type: string dns: type: object additionalProperties: false required: - group - user properties: group: type: string user: type: string filters: type: object additionalProperties: false required: - groupsByUsername - userByUsername properties: groupsByUsername: type: string userByUsername: type: string user_mapping: type: object additionalProperties: false required: - email - firstName - id - lastName - username properties: email: type: string firstName: type: string id: type: string lastName: type: string username: type: string group_mapping: type: object additionalProperties: false required: - groupName - id properties: groupName: type: string id: type: string test_connection: type: object additionalProperties: false required: - username - password properties: username: type: string password: type: string ExternalIdentityProviderGet: example: provider_id: 2e71d283-6248-4c81-98eb-e254a89b7e0a org_id: 2e50e859-0042-46ff-8cf8-1ad6f0c78b67 name: Primary Identity Management Config type: description: SAML 2.0 name: saml service_provider: urls: sign_on: https://example.com/idp/login sign_out: https://example.com/idp/logout saml: audience: example.anypoint.mulesoft.com issuer: https://example.com public_key: - '-----BEGIN CERTIFICATE----- MIID4DCCA8igAwIBAgIOAXD1Vx9oAAAAAE8I+UMwDQYJKoZIhvcNAQELBQAwgaEx ORA3BgNVBAMMMFNlbGZTaWduZWRDZXJTZWxmU2lnbmVkQ2VydF8xOU1hcjIwMjB0 XzE5TWFyMjAyMDEYMBYGA1UECwwPMDBEZjQwMDAwNDNBVjZmMRcwFQYDVQQKDA5T YWxlc2ZvcmNlLmNvbTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbZELMAkGA1UECAwC Q0ExDDAKBgNVBAYTA1VTQTAeFw0yMDAzMjAwMDI4MTJaFw0yMTAzMjAwMDAwMDBa MIGhMTkwNwYDVQQDDDBTZWxmU2lnbmVkQ2VyU2VsZlNpZ25lZENlcnRfMTlNYXIy MDIwdF8xOU1hcjIwMjAxGDAWBgNVBAsMDzAwRGY0MDAwMDAzQVY2ZjEXMBUGA1UE CgwOU2FsZXNmb3JjZS5jb20xFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xCzAJBgNV BAgMAkNBMQwwCgYDVQQGEwNVU0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK AoIBAQCe/YnyilbiG6ptsIQu4V+Oe+hAMNYeBHh9JvnihAYe4z679KVJLpY+rE3N XK+JbZRDCUVewlSj+QhfvykzvJyXUrPC2NyrshW9DFUB36JbOBIYQL00s4TNEBTt z/LgDuVn0B7p5uk1HfeL6Ycul3XmAss913XRRMBmdTwi6vK+sVr4rTfzoFxyg7vS AAxDfrZh0mgieuVUENGXmV1OEKuX4G4WIeTwsOz0woHbNXM1M7Q1F9zLJK93QrpS Og0n3oAFyk9KAQ/Gv3AW12N5VlUAc+/NttRkO9k+ZhDllZSDWQSYokRbrxXurske 22Tp+rxr80lGFqDyb6bTem1c8s8jAgMBAAGjggESMIIBDjAdBgNVHQ4EFgQUM50l bdnhkFhJAcf/28trPacGk18wDwYDVR0TAQH/BAUwAwEB/zCB2wYDVR0jBIHTMIHQ gBQznSVt2eGQWEkBx//by2s9pwaTX6GBp6SBpDCBoTE5MDcGA1UEAwwwU2VsZlNp Z25lZENlclNlbGZTaWduZWRDZXJ0XzE5TWFyMjAyMHRfMTlNYXIyMDIwMRgwFgYD VQQLDA8wMERmNDAwMDAwM0FWNmYxFzAVBgNVBAoMDlNhbGVzZm9yY2UuY29tMRYw FAYDVQQHDA1TYW4gRnJhbmNpc2NvMQswCQYDVQQIDAJDQTEMMAoGA1UEBhMDVVNB gg4BcPVXH2gAAAAATwj5QzANBgkqhkiG9w0BAQsFAAOCAQEANEupbkT3hHAP0iXR 7TUNxYBi5y/TeMHE7SfRboMZpjLKMRiRCpCjSl2KlZp+wmGpGBfRiL1fPmiDOiPp 3XyWcJ5+xPL5btQhcnD+YsMcFLsKIIbCtqS0NXUWa1K4oRq2z4/EBrXZLtniQ+8M oQnXYvH5zKkpjH1JM8BDfceymgrYsdXmu3rflXuvxBLsDMDdk0zTojL1rIqzxTPH S2iabxwLeVWQEGPtXmRtS+kP6CY1pNoYbAFrJzZf4wakx95vwTqSXfcIoFdHUG5B X6db+brGnxVgv4mL8ZbxljYhcNDMyNm6kGoPqEyhGHhDTnQyn1RKcStBxkDXPIL3 b6ojYg== -----END CERTIFICATE-----' claims_mapping: group_attribute: memberOf sp_initiated_sso_enabled: false idp_initiated_sso_enabled: true require_encrypted_saml_assertions: false x-amf-union: - $ref: '#/components/schemas/SAMLProviderGet' - $ref: '#/components/schemas/LDAPProviderGet' - $ref: '#/components/schemas/OpenIDProviderGet' ExternalIdentityProviderPatch: example: name: Updated Identity Management Config type: description: SAML 2.0 service_provider: urls: sign_on: https://example.com/idp/login sign_out: https://example.com/idp/logout saml: audience: example.anypoint.mulesoft.com issuer: https://example.com public_key: - '-----BEGIN CERTIFICATE----- MIID4DCCA8igAwIBAgIOAXD1Vx9oAAAAAE8I+UMwDQYJKoZIhvcNAQELBQAwgaEx ORA3BgNVBAMMMFNlbGZTaWduZWRDZXJTZWxmU2lnbmVkQ2VydF8xOU1hcjIwMjB0 XzE5TWFyMjAyMDEYMBYGA1UECwwPMDBEZjQwMDAwNDNBVjZmMRcwFQYDVQQKDA5T YWxlc2ZvcmNlLmNvbTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbZELMAkGA1UECAwC Q0ExDDAKBgNVBAYTA1VTQTAeFw0yMDAzMjAwMDI4MTJaFw0yMTAzMjAwMDAwMDBa MIGhMTkwNwYDVQQDDDBTZWxmU2lnbmVkQ2VyU2VsZlNpZ25lZENlcnRfMTlNYXIy MDIwdF8xOU1hcjIwMjAxGDAWBgNVBAsMDzAwRGY0MDAwMDAzQVY2ZjEXMBUGA1UE CgwOU2FsZXNmb3JjZS5jb20xFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xCzAJBgNV BAgMAkNBMQwwCgYDVQQGEwNVU0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK AoIBAQCe/YnyilbiG6ptsIQu4V+Oe+hAMNYeBHh9JvnihAYe4z679KVJLpY+rE3N XK+JbZRDCUVewlSj+QhfvykzvJyXUrPC2NyrshW9DFUB36JbOBIYQL00s4TNEBTt z/LgDuVn0B7p5uk1HfeL6Ycul3XmAss913XRRMBmdTwi6vK+sVr4rTfzoFxyg7vS AAxDfrZh0mgieuVUENGXmV1OEKuX4G4WIeTwsOz0woHbNXM1M7Q1F9zLJK93QrpS Og0n3oAFyk9KAQ/Gv3AW12N5VlUAc+/NttRkO9k+ZhDllZSDWQSYokRbrxXurske 22Tp+rxr80lGFqDyb6bTem1c8s8jAgMBAAGjggESMIIBDjAdBgNVHQ4EFgQUM50l bdnhkFhJAcf/28trPacGk18wDwYDVR0TAQH/BAUwAwEB/zCB2wYDVR0jBIHTMIHQ gBQznSVt2eGQWEkBx//by2s9pwaTX6GBp6SBpDCBoTE5MDcGA1UEAwwwU2VsZlNp Z25lZENlclNlbGZTaWduZWRDZXJ0XzE5TWFyMjAyMHRfMTlNYXIyMDIwMRgwFgYD VQQLDA8wMERmNDAwMDAwM0FWNmYxFzAVBgNVBAoMDlNhbGVzZm9yY2UuY29tMRYw FAYDVQQHDA1TYW4gRnJhbmNpc2NvMQswCQYDVQQIDAJDQTEMMAoGA1UEBhMDVVNB gg4BcPVXH2gAAAAATwj5QzANBgkqhkiG9w0BAQsFAAOCAQEANEupbkT3hHAP0iXR 7TUNxYBi5y/TeMHE7SfRboMZpjLKMRiRCpCjSl2KlZp+wmGpGBfRiL1fPmiDOiPp 3XyWcJ5+xPL5btQhcnD+YsMcFLsKIIbCtqS0NXUWa1K4oRq2z4/EBrXZLtniQ+8M oQnXYvH5zKkpjH1JM8BDfceymgrYsdXmu3rflXuvxBLsDMDdk0zTojL1rIqzxTPH S2iabxwLeVWQEGPtXmRtS+kP6CY1pNoYbAFrJzZf4wakx95vwTqSXfcIoFdHUG5B X6db+brGnxVgv4mL8ZbxljYhcNDMyNm6kGoPqEyhGHhDTnQyn1RKcStBxkDXPIL3 b6ojYg== -----END CERTIFICATE-----' claims_mapping: group_attribute: memberOf sp_initiated_sso_enabled: false idp_initiated_sso_enabled: true require_encrypted_saml_assertions: false x-amf-union: - $ref: '#/components/schemas/SAMLProviderPatch' - $ref: '#/components/schemas/LDAPProviderPatch' - $ref: '#/components/schemas/OpenIDProviderPatch' SAMLProviderKeysArray: example: - id: 1e2994ff-e6f1-4d11-ab93-3f17af9c9630 primary: false created_at: 2020-07-02 18:28:25.218000+00:00 - id: 624e3b14-60f4-4813-955a-ef2049f3a0da primary: true created_at: 2020-07-03 18:28:25.218000+00:00 type: array minItems: 1 items: $ref: '#/components/schemas/SAMLProviderKeys' SAMLProviderKeys: example: id: 1e2994ff-e6f1-4d11-ab93-3f17af9c9630 primary: false created_at: 2020-07-02 18:28:25.218000+00:00 type: object additionalProperties: false required: - id - primary - created_at properties: id: type: string primary: type: boolean created_at: type: string is_default_certificate: type: boolean IdentityProviderSettings: example: allow_new_non_sso_users: true type: object additionalProperties: false properties: allow_new_non_sso_users: type: boolean bypass_expiration: type: boolean ExternalIdentityProviderLegacy: example: 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 type: object additionalProperties: false required: - identity_management properties: identity_management: x-amf-union: - $ref: '#/components/schemas/SAMLProviderLegacyWithStrPublicKey' - $ref: '#/components/schemas/SAMLProviderLegacyWithArrPublicKey' - $ref: '#/components/schemas/OpenIDProviderLegacy' - $ref: '#/components/schemas/LDAPProviderLegacy' idprovider_id: type: string LDAPProviderTestOld: type: object additionalProperties: false required: - identity_management properties: identity_management: type: object additionalProperties: false required: - test_connection properties: user_mapping: type: object additionalProperties: false properties: email: type: string firstName: type: string id: type: string lastName: type: string username: type: string test_connection: type: object additionalProperties: false required: - username - password properties: username: type: string password: type: string filters: type: object additionalProperties: false properties: groupsByUsername: type: string userByUsername: type: string userByEmail: type: string groupByGroupName: type: string name: type: string dns: type: object additionalProperties: false properties: group: type: string user: type: string group_mapping: type: object additionalProperties: false properties: groupName: type: string id: type: string connection: type: object additionalProperties: false properties: binddn: type: string connectTimeoutSeconds: type: number host: type: string operationTimeoutMs: type: number password: type: string port: type: number validatecert: type: boolean type: type: object additionalProperties: false properties: description: type: string name: enum: - ldap type: string search_bases: type: object additionalProperties: false properties: group: type: string user: type: string RoleGroupUpdate: example: name: Organization Administrators description: Organization Administrators external_names: - external_group_name: administrators provider_id: 2e50e859-0042-46ff-8cf8-1ad6f0c78b67 type: object additionalProperties: false properties: role_group_id: $ref: '#/components/schemas/uuid' name: type: string minLength: 1 maxLength: 255 description: type: string minLength: 1 maxLength: 255 external_names: $ref: '#/components/schemas/RoleGroupExternalName' Team: description: 'A Team. For internal/private/shared teams, all fields except external_org_id are returned. For external teams, external_org_id is returned but the other optional fields are not. ' example: 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-15 09:36:07.123000+00:00 updated_at: 2019-07-15 09:36:07.123000+00:00 type: object additionalProperties: false required: - team_id - org_id - org_name - team_name - team_type - ancestor_team_ids properties: team_id: description: The id of the team. Team_id is globally unique. type: string minLength: 1 maxLength: 255 org_id: description: The root organization id where the team is defined. type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ org_name: description: The name of the root organization that manages the team. type: string team_name: $ref: '#/components/schemas/TeamName' team_type: description: The type of the team. enum: - internal - external - private - shared - legacy type: string external_org_id: description: '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. ' type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ external_org_name: description: '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. ' type: string ancestor_team_ids: description: Array of ancestor teams ids starting from either the internal or external root team down to this team's parent. type: array items: $ref: '#/components/schemas/IdString' created_at: description: The time the team was created. type: string format: date-time updated_at: description: The time the team was last modified. type: string format: date-time TeamCreate: example: parent_team_id: 6cad8143-5f3c-4258-8091-2e664819e7f3 team_name: New Team team_type: internal type: object additionalProperties: false required: - parent_team_id - team_name - team_type properties: parent_team_id: description: The team_id of the parent of this team. type: string minLength: 1 maxLength: 255 team_name: $ref: '#/components/schemas/TeamName' team_type: description: '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. ' enum: - internal - private - shared type: string TeamUpdate: example: team_name: New team name type: object additionalProperties: false properties: team_name: $ref: '#/components/schemas/TeamName' team_type: description: '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 ' enum: - internal - private - shared type: string TeamMove: example: parent_team_id: 59a065cf-2d31-4488-9d67-d380a820166b type: object additionalProperties: false required: - parent_team_id properties: parent_team_id: description: '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. ' type: string minLength: 1 maxLength: 255 TeamExternalGroupMapping: type: object additionalProperties: false required: - membership_type - external_group_name properties: membership_type: $ref: '#/components/schemas/TeamMemberType' external_group_name: type: string minLength: 1 maxLength: 255 provider_id: $ref: '#/components/schemas/uuid' TeamExternalGroupMappingList: example: - 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 type: array items: $ref: '#/components/schemas/TeamExternalGroupMapping' RoleAssignmentDetailed: type: object additionalProperties: false required: - name - context_params - role_id properties: name: description: name of the role type: string minLength: 1 maxLength: 255 context_params: $ref: '#/components/schemas/ContextParams' role_id: description: the id of the role type: string minLength: 1 maxLength: 255 RoleAssignmentCollectionRequest: example: - role_id: d74ef94a-4292-4896-b860-b05bd7f90d6d context_params: org: 68ef9520-24e9-4cf2-b2f5-620025690913 type: array items: $ref: '#/components/schemas/RoleAssignment' TeamMember: description: Team members are either users or other teams. type: object additionalProperties: false required: - created_at - is_assigned_via_external_groups - identity_type - updated_at - id - team_name - membership_type properties: created_at: description: The time the team was created. type: string format: date-time is_assigned_via_external_groups: description: whether team membership was granted due to an external group. type: boolean identity_type: enum: - team - user type: string updated_at: description: The time the team was last modified. type: string format: date-time id: description: the id of the member. For teams, this is the team's team_id. For users, this is the user's id. type: string minLength: 1 maxLength: 255 team_name: description: The name of the team or the first & last name of the user. type: string minLength: 1 maxLength: 255 membership_type: description: Whether the member is a regular member or a maintainer. Only users may be team maintainers. enum: - member - maintainer type: string TeamMemberBulkAdd: example: - id: 6ee13e67-2924-4594-a807-9ea75203e27c membership_type: member - id: 3d29dbd3-94fd-4d55-a705-db98bb749a7c membership_type: maintainer type: array maxItems: 100 minItems: 1 items: type: object additionalProperties: false required: - id - membership_type properties: id: description: id of the user to add to the team. type: string minLength: 1 maxLength: 255 membership_type: description: Whether the member is a regular member or a maintainer. Only users may be team maintainers. enum: - member - maintainer type: string TeamMemberIdArray: example: - fc1fc29a-b0e6-4883-aa8a-6797cbb7e3e4 - 2376aa85-02cf-4156-a1cf-345d7069d1d9 type: array maxItems: 100 minItems: 1 items: $ref: '#/components/schemas/IdString' TeamMemberAdd: example: membership_type: member type: object additionalProperties: false required: - membership_type properties: membership_type: description: Whether the member is a regular member or a maintainer. Only users may be team maintainers. enum: - member - maintainer type: string TenantRelationship: type: object additionalProperties: false required: - id - organization - type - enabled - tenantKey - label - sources - createdAt - updatedAt - config properties: id: description: The ID of the Tenant Relationship type: string minLength: 1 maxLength: 255 organization: description: Data describing the Root Organization associated with the Tenant Relationship type: object additionalProperties: false required: - name - id properties: name: description: The name of the Root Organization type: string id: description: The ID of the Root Organization type: string minLength: 1 maxLength: 255 type: description: The type of the Tenant Relationship enum: - SFDC_C2C type: string enabled: description: Whether the Tenant Relationship is currently enabled type: boolean tenantKey: description: The unique ID of the remote tenant. For SFDC_C2C type relationships, this will be a valid GDoT Tenant GUID value type: string minLength: 1 maxLength: 150 label: description: Unique human-friendly name / label for the Tenant Relationship type: string sources: description: Description of the sources of the Tenant Relationship. i.e. whether the Relationship is provisioned or manually created. example: - ADMIN - CSP type: array items: type: string createdAt: description: The date/time the Tenant Relationship was created type: string format: date-time updatedAt: description: The date/time the Tenant Relationship was last updated type: string format: date-time config: description: Additional type-specific configuration type: object additionalProperties: false required: - incomingTrusts - _type - outgoingTrusts - apiEndpoint properties: incomingTrusts: description: Array of currently enabled C2C "incoming trusts" i.e. C2C caller contexts under which the remote Tenant may call into MuleSoft type: array items: type: string _type: description: The type descriptor enum: - SFDC_C2C type: string outgoingTrusts: description: Array of currently enabled C2C "outgoing trusts" i.e. C2C caller contexts under which the MuleSoft Tenant may call the remote Tenant type: array items: type: string apiEndpoint: description: The base HTTPS URI for calling the remote Tenant type: string ManualTenantRelationshipRequest: example: relationshipType: SFDC_C2C tenantKey: tenant-key-1 type: object additionalProperties: false required: - relationshipType - tenantKey properties: relationshipType: description: The type of the Tenant Relationship enum: - SFDC_C2C type: string tenantKey: description: The unique ID of the remote tenant. For SFDC_C2C type relationships, this must be a valid GDoT Tenant GUID value type: string label: description: Unique human-friendly name / label for the Tenant Relationship type: string SingleTenantRelationshipResponse: example: tenantRelationship: 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: - ADMIN 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 type: object additionalProperties: false required: - tenantRelationship properties: tenantRelationship: $ref: '#/components/schemas/TenantRelationship' PatchTenantRelationshipRequest: example: enabled: true label: The New Label type: object additionalProperties: false properties: enabled: description: Whether the Tenant Relationship should be enabled or not type: boolean label: description: An updated label for the Tenant Relationship type: string SetSFDCOrgStatusRequest: example: enabled: true type: object additionalProperties: false required: - enabled properties: enabled: description: Status of the SFDC organization feature type: boolean TeamIsMemberOf: description: 'A Team. For internal/private/shared teams, all fields except external_org_id are returned. For external teams, external_org_id is returned but the other optional fields are not. ' type: object additionalProperties: false required: - is_assigned_via_external_groups - team_type - org_id - org_name - team_id - team_name - membership_type - ancestor_team_ids properties: is_assigned_via_external_groups: description: whether team membership was granted due to an external group. type: boolean created_at: description: The time the team was created. type: string format: date-time team_type: description: The type of the team. enum: - internal - external - private - shared - legacy type: string org_id: description: The root organization id where the team is defined. type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ updated_at: description: The time the team was last modified. type: string format: date-time external_org_name: description: '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. ' type: string org_name: description: The name of the root organization that manages the team. type: string team_id: description: The id of the team. Team_id is globally unique. type: string minLength: 1 maxLength: 255 team_name: $ref: '#/components/schemas/TeamName' membership_type: description: Whether the member is a regular member or a maintainer. enum: - member - maintainer type: string ancestor_team_ids: description: Array of ancestor teams ids starting from either the internal or external root team down to this team's parent. type: array items: $ref: '#/components/schemas/IdString' external_org_id: description: '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. ' type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ RoleGroupApiResponse: example: data: - created_at: 2021-02-27 01:32:59.572000+00:00 updated_at: 2021-02-27 01:32:59.572000+00:00 role_group_id: 1af07a40-cf95-4ed5-a312-7bd453576ac9 name: f25df118-08c9-496d-9689-3690eeac6eba description: d50d05da-880a-4d75-beab-d3c2c1398e10 org_id: 7dc95b9d-aae3-426c-a86d-7f6b19265af1 editable: true external_names: - external_group_name: my external group provider_id: 2e50e859-0042-46ff-8cf8-1ad6f0c78b67 user_count: 1 assignments: - role_id: f5b8dd3e-8988-4f39-afab-79f86c710cd4 context_params: org: 7dc95b9d-aae3-426c-a86d-7f6b19265af1 created_at: 2021-02-26 17:32:59.606836 org_name: and Sons0 total: 1 type: object additionalProperties: false required: - data - total properties: data: type: array items: $ref: '#/components/schemas/RoleGroup' total: type: integer TeamRoleSearchResult: description: 'A Team. For internal/private/shared teams, all fields except external_org_id are returned. For external teams, external_org_id is returned but the other optional fields are not. ' type: object additionalProperties: false required: - team_type - org_id - org_name - team_id - assignments - team_name - ancestor_team_ids properties: created_at: description: The time the team was created. type: string format: date-time team_type: description: The type of the team. enum: - internal - external - private - shared - legacy type: string org_id: description: The root organization id where the team is defined. type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ updated_at: description: The time the team was last modified. type: string format: date-time external_org_name: description: '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. ' type: string org_name: description: The name of the root organization that manages the team. type: string team_id: description: The id of the team. Team_id is globally unique. type: string minLength: 1 maxLength: 255 assignments: type: array items: $ref: '#/components/schemas/RoleAssignmentDetailedWithDate' team_name: $ref: '#/components/schemas/TeamName' ancestor_team_ids: description: Array of ancestor teams ids starting from either the internal or external root team down to this team's parent. type: array items: $ref: '#/components/schemas/IdString' external_org_id: description: '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. ' type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ Organization: type: object SetOrgWideEinsteinStatusRequest: example: enabled: true type: object additionalProperties: false required: - enabled properties: enabled: type: boolean PutEinsteinTermsAndConditionsRequest: example: agree: true type: object additionalProperties: false required: - agree properties: agree: type: boolean Entitlements: example: 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 type: object StringField: type: string minLength: 1 maxLength: 255 uuid: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ InviteRoleGroups: type: object additionalProperties: false required: - invited_to_org - code - invited_at - id - invited_by_user - completed_at - expires_at - invited_email - completed_by_user - status properties: invited_to_org: type: object additionalProperties: false required: - id - name properties: id: $ref: '#/components/schemas/uuid' name: type: string minLength: 1 maxLength: 255 role_groups: $ref: '#/components/schemas/InviteRoleGroupList' code: type: string minLength: 1 maxLength: 255 invited_at: type: string format: date-time id: type: integer invited_by_user: type: object additionalProperties: false required: - id - username - first_name - last_name properties: id: $ref: '#/components/schemas/uuid' username: type: string minLength: 1 maxLength: 255 first_name: type: string minLength: 1 maxLength: 255 last_name: type: string minLength: 1 maxLength: 255 completed_at: x-amf-union: - type: string format: date-time - type: 'null' expires_at: type: string format: date-time invited_email: type: string minLength: 1 maxLength: 255 completed_by_user: x-amf-union: - $ref: '#/components/schemas/uuid' - type: 'null' status: enum: - INVITED - ACCEPTED - CANCELED - EXPIRED type: string InviteTeams: type: object additionalProperties: false required: - invited_to_org - code - invited_at - id - invited_by_user - completed_at - expires_at - invited_email - completed_by_user - status properties: invited_to_org: type: object additionalProperties: false required: - id - name properties: id: $ref: '#/components/schemas/uuid' name: type: string minLength: 1 maxLength: 255 code: type: string minLength: 1 maxLength: 255 invited_at: type: string format: date-time id: type: integer invited_by_user: type: object additionalProperties: false required: - id - username - first_name - last_name properties: id: $ref: '#/components/schemas/uuid' username: type: string minLength: 1 maxLength: 255 first_name: type: string minLength: 1 maxLength: 255 last_name: type: string minLength: 1 maxLength: 255 completed_at: x-amf-union: - type: string format: date-time - type: 'null' teams: $ref: '#/components/schemas/InviteTeamList' expires_at: type: string format: date-time invited_email: type: string minLength: 1 maxLength: 255 completed_by_user: x-amf-union: - $ref: '#/components/schemas/uuid' - type: 'null' status: enum: - INVITED - ACCEPTED - CANCELED - EXPIRED type: string InviteRoles: type: object additionalProperties: false required: - invited_to_org - code - invited_at - id - invited_by_user - completed_at - expires_at - invited_email - completed_by_user - status properties: invited_to_org: type: object additionalProperties: false required: - id - name properties: id: $ref: '#/components/schemas/uuid' name: type: string minLength: 1 maxLength: 255 code: type: string minLength: 1 maxLength: 255 invited_at: type: string format: date-time id: type: integer roles: $ref: '#/components/schemas/InviteRoleList' invited_by_user: type: object additionalProperties: false required: - id - username - first_name - last_name properties: id: $ref: '#/components/schemas/uuid' username: type: string minLength: 1 maxLength: 255 first_name: type: string minLength: 1 maxLength: 255 last_name: type: string minLength: 1 maxLength: 255 completed_at: x-amf-union: - type: string format: date-time - type: 'null' expires_at: type: string format: date-time invited_email: type: string minLength: 1 maxLength: 255 completed_by_user: x-amf-union: - $ref: '#/components/schemas/uuid' - type: 'null' status: enum: - INVITED - ACCEPTED - CANCELED - EXPIRED type: string InviteNewRoleGroups: type: array items: type: object additionalProperties: false required: - email properties: email: type: string minLength: 1 maxLength: 255 role_groups: $ref: '#/components/schemas/InviteRoleGroupList' InviteNewTeams: type: array items: type: object additionalProperties: false required: - email properties: email: type: string minLength: 1 maxLength: 255 role_groups: $ref: '#/components/schemas/InviteRoleGroupList' teams: type: array items: type: object additionalProperties: false required: - team_id - membership_type properties: team_id: $ref: '#/components/schemas/uuid' membership_type: $ref: '#/components/schemas/TeamMemberType' InviteNewRoles: type: array items: type: object additionalProperties: false required: - email properties: email: type: string minLength: 1 maxLength: 255 role_groups: $ref: '#/components/schemas/InviteRoleGroupList' teams: type: array items: type: object additionalProperties: false required: - team_id - membership_type properties: team_id: $ref: '#/components/schemas/uuid' membership_type: $ref: '#/components/schemas/TeamMemberType' roles: $ref: '#/components/schemas/InviteRoleList' OpenAMProvider: type: object additionalProperties: false required: - admin_token - oauth2_client_provider - oauth2_authorization_provider - oauth2_token_provider - oauth2_token_validation_provider - type properties: admin_token: type: object additionalProperties: false required: - urls - username - password properties: urls: type: object additionalProperties: false required: - create properties: create: type: string username: type: string password: type: string name: type: string oauth2_client_provider: type: object additionalProperties: false required: - urls properties: urls: type: object additionalProperties: false required: - create - delete properties: create: type: string delete: type: string scopes: type: array items: type: string default_scopes: type: array items: type: string allowed_client_types: type: object additionalProperties: false required: - Confidential - Public properties: Confidential: type: array items: type: string Public: type: array items: type: string grant_types: type: array items: $ref: '#/components/schemas/GrantType' oauth2_authorization_provider: type: object additionalProperties: false required: - urls properties: urls: type: object additionalProperties: false required: - authorize properties: authorize: type: string providerId: type: string oauth2_token_provider: type: object additionalProperties: false required: - urls properties: urls: type: object additionalProperties: false required: - create properties: create: type: string allow_untrusted_certificates: type: boolean oauth2_token_validation_provider: type: object additionalProperties: false required: - urls properties: urls: type: object additionalProperties: false required: - validate properties: validate: type: string type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - openam type: string version: type: string organizationId: type: string PingFederateProvider: type: object additionalProperties: false required: - oauth2_client_provider - oauth2_authorization_provider - oauth2_token_provider - oauth2_token_validation_provider - type properties: name: type: string oauth2_client_provider: type: object additionalProperties: false required: - urls - username - password properties: urls: type: object additionalProperties: false required: - create - delete properties: create: type: string delete: type: string username: type: string password: type: string grant_types: type: array items: $ref: '#/components/schemas/GrantType' bypass_approval_page: type: boolean send_credentials_in_header: type: boolean oauth2_authorization_provider: type: object additionalProperties: false required: - urls properties: urls: type: object additionalProperties: false required: - authorize properties: authorize: type: string providerId: type: string oauth2_token_provider: type: object additionalProperties: false required: - urls properties: urls: type: object additionalProperties: false required: - create properties: create: type: string allow_untrusted_certificates: type: boolean oauth2_token_validation_provider: type: object additionalProperties: false required: - urls properties: urls: type: object additionalProperties: false required: - validate properties: validate: type: string client_id: type: string client_secret: type: string token_mapping: type: object additionalProperties: false properties: email: type: string firstName: type: string lastName: type: string user: type: string username: type: string type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - ping type: string organizationId: type: string OIDCDynamicClientProvider: type: object additionalProperties: false required: - oidc_dynamic_client_provider - type properties: azure_ad_provider: type: object additionalProperties: false required: - client properties: client: type: object additionalProperties: false required: - registration properties: registration: type: object additionalProperties: false required: - key_expired_in properties: key_expired_in: type: string name: type: string providerId: type: string oidc_dynamic_client_provider: type: object additionalProperties: false required: - client - primary_client - urls properties: issuer: type: string client: type: object additionalProperties: false required: - urls properties: urls: type: object additionalProperties: false required: - register properties: register: type: string registration: type: object additionalProperties: false required: - authorization properties: authorization: type: string token_endpoint_auth_methods_supported: type: array items: type: string primary_client: type: object additionalProperties: false required: - id - secret properties: id: type: string secret: type: string urls: type: object additionalProperties: false required: - authorize - token - introspect properties: authorize: type: string token: type: string introspect: type: string supported_grant_types: type: array items: $ref: '#/components/schemas/GrantType' allow_local_client_deletion: type: boolean allow_external_client_modification: type: boolean client_request_timeout: type: number allow_untrusted_certificates: type: boolean type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - openid-dynamic-client type: string organizationId: type: string OpenAMProviderOptional: type: object additionalProperties: false properties: admin_token: type: object additionalProperties: false properties: urls: type: object additionalProperties: false properties: create: type: string username: type: string password: type: string name: type: string oauth2_client_provider: type: object additionalProperties: false properties: urls: type: object additionalProperties: false properties: create: type: string delete: type: string scopes: type: array items: type: string default_scopes: type: array items: type: string allowed_client_types: type: object additionalProperties: false properties: Confidential: type: array items: type: string Public: type: array items: type: string grant_types: type: array items: $ref: '#/components/schemas/GrantType' oauth2_authorization_provider: type: object additionalProperties: false properties: urls: type: object additionalProperties: false properties: authorize: type: string providerId: type: string oauth2_token_provider: type: object additionalProperties: false properties: urls: type: object additionalProperties: false properties: create: type: string allow_untrusted_certificates: type: boolean oauth2_token_validation_provider: type: object properties: urls: type: object additionalProperties: false properties: validate: type: string type: type: object additionalProperties: false properties: description: type: string organizationId: type: string PingFederateProviderOptional: type: object additionalProperties: false properties: name: type: string oauth2_client_provider: type: object additionalProperties: false properties: urls: type: object additionalProperties: false properties: create: type: string delete: type: string username: type: string password: type: string grant_types: type: array items: $ref: '#/components/schemas/GrantType' bypass_approval_page: type: boolean send_credentials_in_header: type: boolean oauth2_authorization_provider: type: object additionalProperties: false properties: urls: type: object additionalProperties: false properties: authorize: type: string providerId: type: string oauth2_token_provider: type: object additionalProperties: false properties: urls: type: object additionalProperties: false properties: create: type: string allow_untrusted_certificates: type: boolean oauth2_token_validation_provider: type: object additionalProperties: false properties: urls: type: object additionalProperties: false properties: validate: type: string client_id: type: string client_secret: type: string token_mapping: type: object additionalProperties: false properties: email: type: string firstName: type: string lastName: type: string user: type: string username: type: string type: type: object additionalProperties: false properties: description: type: string organizationId: type: string OIDCDynamicClientProviderOptional: type: object additionalProperties: false properties: azure_ad_provider: type: object additionalProperties: false required: - client properties: client: type: object additionalProperties: false required: - registration properties: registration: type: object additionalProperties: false required: - key_expired_in properties: key_expired_in: type: string name: type: string providerId: type: string oidc_dynamic_client_provider: type: object additionalProperties: false properties: issuer: type: string client: type: object additionalProperties: false properties: urls: type: object additionalProperties: false properties: register: type: string registration: type: object additionalProperties: false properties: authorization: type: string token_endpoint_auth_methods_supported: type: array items: type: string primary_client: type: object additionalProperties: false properties: id: type: string secret: type: string urls: type: object additionalProperties: false properties: authorize: type: string introspect: type: string token: type: string supported_grant_types: type: array items: $ref: '#/components/schemas/GrantType' allow_local_client_deletion: type: boolean allow_external_client_modification: type: boolean client_request_timeout: type: number allow_untrusted_certificates: type: boolean type: type: object additionalProperties: false properties: description: type: string organizationId: type: string GrantType: type: object additionalProperties: false required: - name - label - required - exclude - depends properties: name: type: string label: type: string required: type: boolean exclude: type: array items: type: string depends: type: array items: type: string IdString: type: string minLength: 1 maxLength: 255 SAMLProvider: type: object additionalProperties: false required: - name - type - service_provider - saml properties: arc_namespace: type: string name: type: string type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - saml type: string service_provider: type: object additionalProperties: false required: - urls properties: urls: type: object additionalProperties: false required: - sign_on - sign_out properties: sign_on: type: string sign_out: type: string saml: type: object additionalProperties: false required: - audience - issuer - public_key properties: audience: type: string issuer: type: string public_key: type: array maxItems: 2 minItems: 1 items: type: string claims_mapping: type: object additionalProperties: false properties: username_attribute: type: string firstname_attribute: type: string lastname_attribute: type: string email_attribute: type: string group_attribute: type: string idp_initiated_sso_enabled: type: boolean sp_initiated_sso_enabled: type: boolean use_composer_acs_url: type: boolean require_encrypted_saml_assertions: type: boolean login_disabled: type: boolean LDAPProvider: type: object additionalProperties: false required: - name - type - connection - search_bases - dns - filters - user_mapping - group_mapping properties: name: type: string arc_namespace: type: string type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - ldap type: string connection: type: object additionalProperties: false required: - binddn - connectTimeoutSeconds - host - operationTimeoutMs - password - port properties: binddn: type: string connectTimeoutSeconds: type: number host: type: string operationTimeoutMs: type: number password: type: string port: type: number validatecert: type: boolean search_bases: type: object additionalProperties: false required: - group - user properties: group: type: string user: type: string dns: type: object additionalProperties: false required: - group - user properties: group: type: string user: type: string filters: type: object additionalProperties: false required: - groupsByUsername - userByUsername properties: groupsByUsername: type: string userByUsername: type: string user_mapping: type: object additionalProperties: false required: - email - firstName - id - lastName - username properties: email: type: string firstName: type: string id: type: string lastName: type: string username: type: string group_mapping: type: object additionalProperties: false required: - groupName - id properties: groupName: type: string id: type: string OpenIDProviderManual: type: object additionalProperties: false required: - name - type - oidc_provider properties: name: type: string arc_namespace: type: string type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - openid type: string oidc_provider: type: object additionalProperties: false required: - client - urls properties: client: type: object additionalProperties: false required: - credentials properties: credentials: type: object additionalProperties: false required: - id - secret properties: id: type: string secret: type: string issuer: type: string urls: type: object additionalProperties: false required: - authorize - token - userinfo properties: authorize: type: string token: type: string userinfo: type: string group_scope: type: string claims_mapping: type: object additionalProperties: false properties: group_expression: type: string allow_untrusted_certificates: type: boolean login_disabled: type: boolean OpenIDProviderDynamic: type: object additionalProperties: false required: - name - type - oidc_provider properties: name: type: string arc_namespace: type: string type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - openid type: string oidc_provider: type: object additionalProperties: false required: - client - urls properties: client: type: object additionalProperties: false required: - urls properties: urls: type: object additionalProperties: false required: - register properties: register: type: string registration: type: object additionalProperties: false required: - authorization properties: authorization: type: string metadata: type: object additionalProperties: false properties: name: type: string issuer: type: string urls: type: object additionalProperties: false required: - authorize - token - userinfo properties: authorize: type: string token: type: string userinfo: type: string group_scope: type: string claims_mapping: type: object additionalProperties: false properties: group_expression: type: string allow_untrusted_certificates: type: boolean login_disabled: type: boolean SAMLProviderPostResponse: type: object additionalProperties: false required: - name - saml - service_provider - provider_id - type properties: name: type: string saml: type: object additionalProperties: false required: - audience - issuer - public_key properties: audience: type: string issuer: type: string public_key: type: array maxItems: 2 minItems: 1 items: type: string claims_mapping: type: object additionalProperties: false properties: username_attribute: type: string firstname_attribute: type: string lastname_attribute: type: string email_attribute: type: string group_attribute: type: string idp_initiated_sso_enabled: type: boolean sp_initiated_sso_enabled: type: boolean use_composer_acs_url: type: boolean require_encrypted_saml_assertions: type: boolean service_provider: type: object additionalProperties: false required: - urls properties: urls: type: object additionalProperties: false required: - sign_on - sign_out properties: sign_on: type: string sign_out: type: string login_disabled: type: boolean arc_namespace: type: string provider_id: type: string type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - saml type: string LDAPProviderPostResponse: type: object additionalProperties: false required: - user_mapping - filters - name - dns - group_mapping - connection - provider_id - type - search_bases properties: user_mapping: type: object additionalProperties: false required: - email - firstName - id - lastName - username properties: email: type: string firstName: type: string id: type: string lastName: type: string username: type: string filters: type: object additionalProperties: false required: - groupsByUsername - userByUsername properties: groupsByUsername: type: string userByUsername: type: string name: type: string dns: type: object additionalProperties: false required: - group - user properties: group: type: string user: type: string group_mapping: type: object additionalProperties: false required: - groupName - id properties: groupName: type: string id: type: string connection: type: object additionalProperties: false required: - binddn - connectTimeoutSeconds - host - operationTimeoutMs - password - port properties: binddn: type: string connectTimeoutSeconds: type: number host: type: string operationTimeoutMs: type: number password: type: string port: type: number validatecert: type: boolean arc_namespace: type: string provider_id: type: string type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - ldap type: string search_bases: type: object additionalProperties: false required: - group - user properties: group: type: string user: type: string OpenIDProviderManualPostResponse: type: object additionalProperties: false required: - oidc_provider - name - provider_id - type properties: oidc_provider: type: object additionalProperties: false required: - client - urls properties: client: type: object additionalProperties: false required: - credentials properties: credentials: type: object additionalProperties: false required: - id - secret properties: id: type: string secret: type: string issuer: type: string urls: type: object additionalProperties: false required: - authorize - token - userinfo properties: authorize: type: string token: type: string userinfo: type: string group_scope: type: string claims_mapping: type: object additionalProperties: false properties: group_expression: type: string name: type: string login_disabled: type: boolean arc_namespace: type: string allow_untrusted_certificates: type: boolean provider_id: type: string type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - openid type: string OpenIDProviderDynamicPostResponse: type: object additionalProperties: false required: - oidc_provider - name - provider_id - type properties: oidc_provider: type: object additionalProperties: false required: - client - urls properties: client: type: object additionalProperties: false required: - urls properties: urls: type: object additionalProperties: false required: - register properties: register: type: string registration: type: object additionalProperties: false required: - authorization properties: authorization: type: string metadata: type: object additionalProperties: false properties: name: type: string issuer: type: string urls: type: object additionalProperties: false required: - authorize - token - userinfo properties: authorize: type: string token: type: string userinfo: type: string group_scope: type: string claims_mapping: type: object additionalProperties: false properties: group_expression: type: string name: type: string login_disabled: type: boolean arc_namespace: type: string allow_untrusted_certificates: type: boolean provider_id: type: string type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - openid type: string SAMLProviderGet: type: object additionalProperties: false required: - name - org_id - saml - service_provider - provider_id - type properties: name: type: string org_id: type: string saml: type: object additionalProperties: false required: - audience - issuer - public_key properties: audience: type: string issuer: type: string public_key: type: array maxItems: 2 minItems: 1 items: type: string claims_mapping: type: object additionalProperties: false properties: username_attribute: type: string firstname_attribute: type: string lastname_attribute: type: string email_attribute: type: string group_attribute: type: string idp_initiated_sso_enabled: type: boolean sp_initiated_sso_enabled: type: boolean use_composer_acs_url: type: boolean require_encrypted_saml_assertions: type: boolean service_provider: type: object additionalProperties: false required: - urls properties: urls: type: object additionalProperties: false required: - sign_on - sign_out properties: sign_on: type: string sign_out: type: string login_disabled: type: boolean arc_namespace: type: string provider_id: type: string type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - saml type: string LDAPProviderGet: type: object additionalProperties: false required: - user_mapping - filters - name - org_id - dns - group_mapping - connection - provider_id - type - search_bases properties: user_mapping: type: object additionalProperties: false required: - email - firstName - id - lastName - username properties: email: type: string firstName: type: string id: type: string lastName: type: string username: type: string filters: type: object additionalProperties: false required: - groupsByUsername - userByUsername properties: groupsByUsername: type: string userByUsername: type: string name: type: string org_id: type: string dns: type: object additionalProperties: false required: - group - user properties: group: type: string user: type: string group_mapping: type: object additionalProperties: false required: - groupName - id properties: groupName: type: string id: type: string connection: type: object additionalProperties: false required: - binddn - connectTimeoutSeconds - host - operationTimeoutMs - password - port properties: binddn: type: string connectTimeoutSeconds: type: number host: type: string operationTimeoutMs: type: number password: type: string port: type: number validatecert: type: boolean arc_namespace: type: string provider_id: type: string type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - ldap type: string search_bases: type: object additionalProperties: false required: - group - user properties: group: type: string user: type: string OpenIDProviderGet: type: object additionalProperties: false required: - oidc_provider - name - org_id - service_provider - allow_untrusted_certificates - type - provider_id properties: oidc_provider: type: object additionalProperties: false required: - client - issuer - urls properties: client: type: object additionalProperties: false required: - credentials properties: credentials: type: object additionalProperties: false required: - id properties: id: type: string secret: type: string urls: type: object additionalProperties: false required: - register properties: register: type: string registration: type: object additionalProperties: false properties: authorization: type: string metadata: type: object additionalProperties: false properties: name: type: string token_endpoint_auth_methods_supported: type: array items: type: string issuer: type: string urls: type: object additionalProperties: false required: - authorize - redirect - token - userinfo properties: authorize: type: string redirect: type: string token: type: string userinfo: type: string group_scope: type: string claims_mapping: type: object additionalProperties: false properties: group_expression: type: string name: type: string org_id: type: string service_provider: type: object additionalProperties: false required: - urls properties: urls: type: object additionalProperties: false required: - sign_on properties: sign_on: type: string login_disabled: type: boolean allow_untrusted_certificates: type: boolean type: type: object additionalProperties: false required: - name properties: description: type: string name: enum: - openid type: string provider_id: type: string SAMLProviderPatch: type: object additionalProperties: false properties: name: type: string type: type: object additionalProperties: false properties: description: type: string service_provider: type: object additionalProperties: false properties: urls: type: object additionalProperties: false properties: sign_on: type: string sign_out: type: string saml: type: object additionalProperties: false properties: audience: type: string issuer: type: string public_key: type: array maxItems: 2 minItems: 1 items: type: string claims_mapping: type: object additionalProperties: false properties: username_attribute: type: string firstname_attribute: type: string lastname_attribute: type: string email_attribute: type: string group_attribute: type: string idp_initiated_sso_enabled: type: boolean sp_initiated_sso_enabled: type: boolean use_composer_acs_url: type: boolean require_encrypted_saml_assertions: type: boolean login_disabled: type: boolean LDAPProviderPatch: type: object additionalProperties: false properties: name: type: string type: type: object additionalProperties: false properties: description: type: string connection: type: object additionalProperties: false properties: binddn: type: string connectTimeoutSeconds: type: number host: type: string operationTimeoutMs: type: number password: type: string port: type: number validatecert: type: boolean search_bases: type: object additionalProperties: false properties: group: type: string user: type: string dns: type: object additionalProperties: false properties: group: type: string user: type: string filters: type: object additionalProperties: false properties: groupsByUsername: type: string userByUsername: type: string user_mapping: type: object additionalProperties: false properties: email: type: string firstName: type: string id: type: string lastName: type: string username: type: string group_mapping: type: object additionalProperties: false properties: groupName: type: string id: type: string OpenIDProviderPatch: type: object additionalProperties: false properties: name: type: string type: type: object additionalProperties: false properties: description: type: string oidc_provider: type: object additionalProperties: false properties: client: type: object additionalProperties: false properties: credentials: type: object additionalProperties: false properties: id: type: string secret: type: string urls: type: object additionalProperties: false properties: register: type: string registration: type: object additionalProperties: false properties: authorization: type: string metadata: type: object additionalProperties: false properties: name: type: string issuer: type: string urls: type: object additionalProperties: false properties: authorize: type: string token: type: string userinfo: type: string group_scope: type: string claims_mapping: type: object additionalProperties: false properties: group_expression: type: string allow_untrusted_certificates: type: boolean login_disabled: type: boolean SAMLProviderLegacyWithStrPublicKey: type: object additionalProperties: false properties: name: type: string type: type: object additionalProperties: false properties: description: type: string name: enum: - saml type: string service_provider: type: object additionalProperties: false properties: name: type: string url: type: string urls: type: object additionalProperties: false properties: sign_on: type: string sign_out: type: string saml: type: object additionalProperties: false properties: name: type: string audience: type: string issuer: type: string public_key: type: string group_attribute: type: string claims_mapping: type: object additionalProperties: false properties: username_attribute: type: string firstname_attribute: type: string lastname_attribute: type: string email_attribute: type: string group_attribute: type: string idp_initiated_sso_enabled: type: boolean sp_initiated_sso_enabled: type: boolean use_composer_acs_url: type: boolean bypass_expiration: type: boolean login_disabled: type: boolean require_encrypted_saml_assertions: type: boolean allow_new_non_sso_users: type: boolean SAMLProviderLegacyWithArrPublicKey: type: object additionalProperties: false properties: name: type: string type: type: object additionalProperties: false properties: description: type: string name: enum: - saml type: string service_provider: type: object additionalProperties: false properties: name: type: string url: type: string urls: type: object additionalProperties: false properties: sign_on: type: string sign_out: type: string saml: type: object additionalProperties: false properties: name: type: string audience: type: string issuer: type: string public_key: type: array maxItems: 2 minItems: 1 items: type: string group_attribute: type: string claims_mapping: type: object additionalProperties: false properties: username_attribute: type: string firstname_attribute: type: string lastname_attribute: type: string email_attribute: type: string group_attribute: type: string idp_initiated_sso_enabled: type: boolean sp_initiated_sso_enabled: type: boolean use_composer_acs_url: type: boolean bypass_expiration: type: boolean login_disabled: type: boolean require_encrypted_saml_assertions: type: boolean allow_new_non_sso_users: type: boolean OpenIDProviderLegacy: type: object additionalProperties: false properties: name: type: string type: type: object additionalProperties: false properties: description: type: string name: enum: - openid type: string oidc_provider: type: object additionalProperties: false properties: name: type: string client: type: object additionalProperties: false properties: credentials: type: object additionalProperties: false properties: id: type: string secret: type: string urls: type: object additionalProperties: false properties: register: type: string registration: type: object additionalProperties: false properties: authorization: type: string issuer: type: string urls: type: object additionalProperties: false properties: authorize: type: string token: type: string userinfo: type: string group_scope: type: string claims_mapping: type: object additionalProperties: false properties: group_expression: type: string allow_untrusted_certificates: type: boolean allow_new_non_sso_users: type: boolean login_disabled: type: boolean LDAPProviderLegacy: type: object additionalProperties: false properties: name: type: string type: type: object additionalProperties: false properties: description: type: string name: enum: - ldap type: string connection: type: object additionalProperties: false properties: binddn: type: string connectTimeoutSeconds: type: number host: type: string operationTimeoutMs: type: number password: type: string port: type: number validatecert: type: boolean search_bases: type: object additionalProperties: false properties: group: type: string user: type: string dns: type: object additionalProperties: false properties: group: type: string user: type: string filters: type: object additionalProperties: false properties: groupsByUsername: type: string userByUsername: type: string userByEmail: type: string groupByGroupName: type: string user_mapping: type: object additionalProperties: false properties: email: type: string firstName: type: string id: type: string lastName: type: string username: type: string group_mapping: type: object additionalProperties: false properties: groupName: type: string id: type: string RoleGroupExternalName: type: array items: x-amf-union: - type: string - $ref: '#/components/schemas/RoleGroupExternalMapping' TeamName: description: The name of the team. Name is unique among teams within the organization. type: string pattern: ^[a-zA-Z\d\-_\s]+$ minLength: 1 maxLength: 255 TeamMemberType: enum: - member - maintainer type: string ContextParams: type: object minProperties: 0 maxProperties: 7 patternProperties: ^.*$: type: string minLength: 1 maxLength: 255 RoleAssignment: type: object additionalProperties: false required: - role_id - context_params properties: role_id: description: the id of the role type: string minLength: 1 maxLength: 255 context_params: $ref: '#/components/schemas/ContextParams' RoleGroup: type: object required: - role_group_id - name - description - org_id - editable - user_count - external_names - created_at - updated_at properties: role_group_id: $ref: '#/components/schemas/uuid' name: type: string minLength: 1 maxLength: 255 description: type: string minLength: 1 maxLength: 255 org_id: $ref: '#/components/schemas/uuid' editable: type: boolean user_count: type: integer external_names: $ref: '#/components/schemas/RoleGroupExternalName' created_at: type: string format: date-time updated_at: type: string format: date-time assignments: type: array items: {} RoleAssignmentDetailedWithDate: type: object additionalProperties: false required: - created_at - name - context_params - role_id properties: created_at: description: Time at which the role was assigned type: string format: date-time name: description: name of the role type: string minLength: 1 maxLength: 255 context_params: $ref: '#/components/schemas/ContextParams' role_id: description: the id of the role type: string minLength: 1 maxLength: 255 InviteRoleGroupList: type: array items: type: object additionalProperties: false required: - name - role_group_id properties: name: type: string minLength: 1 maxLength: 255 role_group_id: $ref: '#/components/schemas/uuid' InviteTeamList: type: array items: type: object additionalProperties: false required: - team_name - team_id - membership_type properties: team_name: type: string minLength: 1 maxLength: 255 team_id: $ref: '#/components/schemas/uuid' membership_type: $ref: '#/components/schemas/TeamMemberType' InviteRoleList: type: array items: type: object additionalProperties: false required: - role_id - context_params properties: role_id: $ref: '#/components/schemas/uuid' context_params: $ref: '#/components/schemas/ContextParams' RoleGroupExternalMapping: type: object additionalProperties: false required: - external_group_name - provider_id properties: external_group_name: type: string minLength: 1 maxLength: 255 provider_id: $ref: '#/components/schemas/uuid' parameters: XOrigin_clientId_Path: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/clientId_Path XOrigin_roleId_Path: name: roleId required: true in: path schema: type: string description: The unique identifier of the role. x-origin: - api: urn:api:access-management operation: listClientsRoles description: GET `/clients/{clientId}/roles` in this API; use `id` values as `roleId`. values: $.id labels: $.name XOrigin_organizationId_Query: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/organizationId_Query XOrigin_connectedApplicationClientId_Path: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/clientId_Path XOrigin_environmentId_Path: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/environmentId_Path XOrigin_organizationId_Path: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/organizationId_Path XOrigin_clientProviderId_Path: name: clientProviderId required: true in: path schema: type: string description: The unique identifier of the client provider id. x-origin: - api: urn:api:access-management operation: listClientProviders description: GET `/organizations/{organizationId}/clientProviders` in this API; use `data[].providerId` values as `clientProviderId`. values: $.data[*].providerId labels: $.data[*].name XOrigin_clientProviderClientId_Path: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/clientId_Path XOrigin_orgScopedClientId_Path: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/clientId_Path XOrigin_orgScopedConnectedApplicationClientId_Path: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/clientId_Path XOrigin_identityProviderId_Path: name: identityProviderId required: true in: path schema: type: string description: The unique identifier of the identity provider id. x-origin: - api: urn:api:access-management operation: listIdentityProviders description: GET `/organizations/{organizationId}/identityProviders` in this API; use `data[].provider_id` values as `identityProviderId`. values: $.data[*].provider_id labels: $.data[*].name XOrigin_userId_Path: name: userId description: The ID of the user in GUID format required: true in: path schema: type: string x-origin: - api: urn:api:access-management operation: listMembers description: GET `/organizations/{organizationId}/members` in this API; use `id` values as `userId`. values: $.id labels: $.name XOrigin_roleGroupId_Path: name: roleGroupId description: GUID of the organization role group required: true in: path schema: type: string x-origin: - api: urn:api:access-management operation: listRolegroups description: GET `/organizations/{organizationId}/rolegroups` in this API; use `id` values as `roleGroupId`. values: $.id labels: $.name XOrigin_rolegroupUserId_Path: name: userId description: GUID of the user to assign required: true in: path schema: type: string x-origin: - api: urn:api:access-management operation: listRolegroupsUsers description: GET `/organizations/{organizationId}/rolegroups/{roleGroupId}/users` in this API; use `id` values as `userId`. values: $.id labels: $.name XOrigin_teamId_Path: name: teamId description: id of the team required: true in: path schema: type: string minLength: 1 maxLength: 255 x-origin: - api: urn:api:access-management operation: listTeams description: GET `/organizations/{organizationId}/teams` in this API; use `data[].team_id` values as `teamId`. values: $.data[*].team_id labels: $.data[*].name XOrigin_teamMemberId_Path: name: userId description: user id required: true in: path schema: type: string minLength: 1 maxLength: 255 x-origin: - api: urn:api:access-management operation: listTeamsMembers description: GET `/organizations/{organizationId}/teams/{teamId}/members` in this API; use `data[].id` values as `userId`. values: $.data[*].id labels: $.data[*].name XOrigin_orgScopedUserId_Path: name: userId description: The ID of the user in GUID format required: true in: path schema: type: string x-origin: - api: urn:api:access-management operation: listUsers description: GET `/organizations/{organizationId}/users` in this API; use `id` values as `userId`. values: $.id labels: $.name XOrigin_userRolegroupId_Path: name: roleGroupId description: The ID of the role group in GUID format required: true in: path schema: type: string x-origin: - api: urn:api:access-management operation: listUsersRolegroups description: GET `/organizations/{organizationId}/users/{userId}/rolegroups` in this API; use `id` values as `roleGroupId`. values: $.id labels: $.name XOrigin_userRoleId_Path: name: roleId description: The ID of the role in GUID format required: true in: path schema: type: string x-origin: - api: urn:api:access-management operation: listUsersRoles description: GET `/organizations/{organizationId}/users/{userId}/roles` in this API; use `id` values as `roleId`. values: $.id labels: $.name XOrigin_globalRoleId_Path: name: roleId description: The ID of the role in GUID format required: true in: path schema: type: string x-origin: - api: urn:api:access-management operation: listRoles description: GET `/roles` in this API; use `id` values as `roleId`. values: $.id labels: $.name XOrigin_globalUserId_Path: name: userId description: The ID of the user in GUID format required: true in: path schema: type: string x-origin: - api: urn:api:access-management operation: listAllUsers description: GET `/users` in this API; use `id` values as `userId`. values: $.id labels: $.name XOrigin_globalUserRoleId_Path: name: roleId description: The ID of the role in GUID format required: true in: path schema: type: string x-origin: - api: urn:api:access-management operation: listAllUserRoles description: GET `/users/{userId}/roles` in this API; use `id` values as `roleId`. values: $.id labels: $.name XOrigin_v2OrganizationId_Path: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/organizationId_Path