OutSystems

OutSystems Users API

The users API from OutSystems — 10 operation(s) for users.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 24

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /users/bulk Create users in bulk · Bulk create users and optionally in the built-in identity provider #
Ask an LLM
“How do I create up to 100 users in one request?”
“Can bulk-created users also be added to the built-in identity provider?”
Tell an agent
Create these users in bulk: {records}.
Bulk-import the user records {records}.
GET /users/bulk/{key} Check a bulk user creation's status · Get the bulk user operation status #
Ask an LLM
“Did my bulk user import finish, and which records failed?”
“How do I check the per-user results of a bulk create?”
Tell an agent
Get the status of bulk user operation {key}.
Show the per-record results of bulk import {key}.
POST /users/{key}/application-roles/{roleKey} Grant an application role to a user · Grants an application role to a user #
Ask an LLM
“How do I give one user an application role?”
“Can I assign an end user to an app role directly, not through a group?”
Tell an agent
Grant application role {roleKey} to user {key}.
Give user {key} the app role {roleKey}.
DELETE /users/{key}/application-roles/{roleKey} Revoke an application role from a user · Revokes an application role to a user #
Ask an LLM
“How do I take an application role away from a user?”
“Can I remove one user's direct app role assignment?”
Tell an agent destructive · confirm first
Revoke application role {roleKey} from user {key}.
Remove app role {roleKey} from user {key}.
GET /users/{key}/application-roles List a user's application roles · Returns the list of application roles associated with a user #
Ask an LLM
“Which application roles does a given user have?”
“Can I tell whether a user's app role came directly or via a group?”
Tell an agent
List the application roles of user {key}.
Show user {key}'s application roles for app {assetKey}.
GET /users/{key}/organization-roles List a user's organization roles · Returns the list of organization roles associated with a user #
Ask an LLM
“What organization roles does a team member hold?”
“Can I check my own organization roles without extra permissions?”
Tell an agent
List the organization roles of user {key}.
Show user {key}'s organization roles scoped to assets {assetKeys}.
POST /users/{key}/organization-roles/{roleKey} Grant an organization role to a user · Grant organization roles to a user #
Ask an LLM
“How do I give a member an organization role?”
“Can I grant an organization role for a limited period or for specific assets?”
Tell an agent
Grant organization role {roleKey} to user {key}.
Grant org role {roleKey} to user {key} for {grantPeriod}.
DELETE /users/{key}/organization-roles/{roleKey} Revoke an organization role from a user · Delete a user's organization roles #
Ask an LLM
“How do I remove an organization role from a member?”
“Can I revoke an organization role only for certain assets?”
Tell an agent destructive · confirm first
Revoke organization role {roleKey} from user {key}.
Remove org role {roleKey} from user {key} for assets {assetKeys}.
GET /users/count Count users · Returns the user count based on specified conditions #
Ask an LLM
“How many active users do I have in ODC?”
“Can I count users who logged in during a certain period?”
Tell an agent
Count all users with status {status}.
Count users who logged in since {lastLoginAtSince}.
POST /users Create a user · Creates a new user #
Ask an LLM
“How do I add a single new user to ODC?”
“Can I add a new user to the built-in identity provider at creation?”
Tell an agent
Create user {name} with email {email}.
Add user {email} with username {username} to the built-in identity provider.
GET /users List users · Returns the list of users based on specified conditions #
Ask an LLM
“Which users exist in my ODC organization?”
“Can I search users by name, email or username?”
Tell an agent
List users whose name or email contains {nameOrEmailContains}.
List users who last logged in before {lastLoginAtTo}.
DELETE /users/{key} Delete a user · Deletes a user #
Ask an LLM
“Can I delete a user from my organization?”
“What permission is required to remove a user?”
Tell an agent destructive · confirm first
Delete user {key}.
Remove user {key} permanently.
GET /users/{key} Get a user · Retrieves a user #
Ask an LLM
“How do I see the profile of one user?”
“What details does ODC return for a user key?”
Tell an agent
Get user {key}.
Show the profile of user {key}.
PATCH /users/{key} Update a user's profile · Updates the user #
Ask an LLM
“How do I deactivate a user without deleting them?”
“Can I change a user's display name or photo?”
Tell an agent
Rename user {key} to {name}.
Set user {key}'s active status to {isActive}.
GET /users/{key}/groups List a user's groups · Returns a list of groups associated with a user #
Ask an LLM
“Which groups is a given user a member of?”
“Can I list a user's group memberships in one stage?”
Tell an agent
List the groups user {key} belongs to.
Show user {key}'s groups in stage {environmentKey}.
GET /users/ Lists all the users #
POST /users/ Creates a user with the specified details #
GET /users/{UserKey}/ Returns the details of a given user #
PUT /users/{UserKey}/ Updates a user with the specified details #
GET /users/{UserKey}/blockedlogins/ Gets the users blocked login attempts #
DELETE /users/{UserKey}/blockedlogins/ Unblocks a given user #
POST /users/{UserKey}/setpassword/ Allows to change a password of a given user #
POST /users/{UserKey}/applications/ Grants a given role to the given application to the user #
DELETE /users/{UserKey}/applications/{ApplicationKey}/ Revokes user's role in application permission #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/openapi/outsystems-users-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/json-schema/outsystems-user-profile-api-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/json-schema/outsystems-bulk-user-profile-operation-api-record-bulk-api-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/json-schema/outsystems-user-profile-create-api-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/json-schema/outsystems-grant-details-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/json-schema/outsystems-organization-role-by-user-api-response-paginated-response-api-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/json-schema/outsystems-user-application-role-api-response-paginated-response-api-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/outsystems:outsystems-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

outsystems-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Outsystems Users API
  version: '1.0'
  description: 'Operations tagged users across 2 of this provider''s published API definitions: outsystems-user-access-management-api-v1-openapi.json, lifetime-api.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ODC_PORTAL_DOMAIN/api/identity/v1
  description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/identity/v1
  description: User and Access Management API
  variables:
    odc-portal-domain:
      default: ODC_PORTAL_DOMAIN
      description: The domain of your organization
- url: /lifetimeapi/rest/v2
tags:


# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/openapi/outsystems-users-api-openapi.yml