How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OutSystems Users API

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

OutSystems Users API is one of 37 APIs that OutSystems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 15 operations across 10 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 2 base URLs: https://ODC_PORTAL_DOMAIN/api/identity/v1, https://{odc-portal-domain}/api/identity/v1.

15 operations 10 paths 35 schemas 3 DELETE7 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://{odc-portal-domain}/api/identity/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

OutSystems Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Enter your bearer token in the format 'Bearer {token}'

Paths & Operations 15

Across 10 paths, the API surfaces 15 operations — 3 DELETE, 7 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

users 15
POST
/users/bulk
Bulk create users and optionally in the built-in identity provider.
BulkUserProfile_CreateBulkUserProfilesOperation body → 202400401403429
GET
/users/bulk/{key}
Get the bulk user operation status.
BulkUserProfile_GetBulkUserProfileOperationStatus 1 param → 200400401403404429
POST
/users/{key}/application-roles/{roleKey}
Grants an application role to a user.
UserApplicationRoles_GrantApplicationRoleToUser 2 params → 201400401403404429
DELETE
/users/{key}/application-roles/{roleKey}
Revokes an application role to a user.
UserApplicationRoles_RevokeApplicationRoleForUser 2 params → 204400401403404429
GET
/users/{key}/application-roles
Returns the list of application roles associated with a user.
UserApplicationRoles_QueryUserApplicationRoles 13 params → 200400401403404429
GET
/users/{key}/organization-roles
Returns the list of organization roles associated with a user.
UserOrganizationRoles_GetUserOrganizationRoles 5 params → 200400401403404429
POST
/users/{key}/organization-roles/{roleKey}
Grant organization roles to a user.
UserOrganizationRoles_GrantOrganizationRoleToUser 2 params body → 201400401403404429
DELETE
/users/{key}/organization-roles/{roleKey}
Delete a user's organization roles.
UserOrganizationRoles_RevokeOrganizationRoleForUser 2 params body → 204400401403404429
GET
/users/count
Returns the user count based on specified conditions.
UserProfile_CountUsers 10 params → 200400401403429
POST
/users
Creates a new user.
UserProfile_CreateUser body → 201401400403429
GET
/users
Returns the list of users based on specified conditions.
UserProfile_QueryUsers 19 params → 200400401403429
DELETE
/users/{key}
Deletes a user.
UserProfile_DeleteUser 1 param → 204400401403404429
GET
/users/{key}
Retrieves a user.
UserProfile_GetUser 2 params → 200400401403404429
PATCH
/users/{key}
Updates the user.
UserProfile_PatchUser 1 param body → 400401204403404429
GET
/users/{key}/groups
Returns a list of groups associated with a user.
UserProfile_QueryGroupsByUser 9 params → 200400401403404429

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are UserProfileApiResponse (11 properties), UserIdpProfileResponse (10 properties), UserApplicationRoleApiResponse (9 properties), UserProfileCreateApiRequest (8 properties). Each schema is shown below with its type and property counts.

UserApplicationRoleApiResponse
object
9 properties
UserProfileApiResponsePaginatedResponseApi
object
2 properties
ProblemDetails
object
A standardized error response as per RFC 7807 (Problem Details for HTTP APIs).
7 properties
UserProfileCreateApiRequestBulkApiRequest
object
1 property 1 required
UserGroupResponsePaginatedResponseApi
object
2 properties
BulkUserProfileOperationApiRecordBulkApiResponse
object
5 properties
UserProfileWithApplicationRolesEmbeddedResponse
object
2 properties
OrganizationRoleByUserApiResponse
object
5 properties
UserProfileCreateResponse
object
1 property
MembershipType
string
UserProfileCountApiResponse
object
1 property
BulkApiOperationStatus
string
UserProfileCreateApiRequest
object
8 properties
UserGroupResponse
object
2 properties 2 required
OrganizationRoleAssignmentScope
string
API query scope for listing a user's organization role assignments.
UserApplicationRoleApiResponsePaginatedResponseApi
object
2 properties
AssignmentSource
string
AssignedGroupInfoApiResponse
object
3 properties
GrantPeriodApiModel
object
2 properties
OrganizationRoleByUserApiResponsePaginatedResponseApi
object
2 properties
UserProfileApiResponse
object
11 properties
UserProfilePatchRequest
object
3 properties
BulkUserProfileOperationApiRecord
object
4 properties
BulkUserProfileOperationApiRecordBulkApiOperation
object
4 properties
PageInfoWithTotalsApi
object
6 properties 3 required
BulkApiStatus
string
RevokeDetailsRequest
object
1 property
GrantDetailsRequest
object
3 properties
UserProfileStatus
string
GroupApiResponse
object
7 properties
ForeignClaimModel
object
3 properties 2 required
UserIdpProfileResponse
object
10 properties
GroupIdpClaimMappingEmbedded
object
4 properties 3 required
UserProfileEmbedType
string
UserProfileAccessResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

outsystems-users-api-openapi.yml Raw ↑

Other APIs OutSystems publishes across the network.

OutSystems Remote MCP Server
OutSystems Analysis Status API
OutSystems Application Roles API
OutSystems Assets API
OutSystems Assets Quality Metrics API
OutSystems Build API
OutSystems Build Operations API
OutSystems Code Analyses API
OutSystems Deletion Analyses API
OutSystems Deployed Assets API
OutSystems Deployment Analyses API
OutSystems Deployment Operations API
Where this information came from

This is an independent, third-party profile of OutSystems Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.