APIs.io Engineering Platform User Provisioning API
The **User Provisioning** endpoints enable you to provision and manage your Postman users.- You can only deactivate users with the SCIM API. You cannot permanently delete users with the API.- Users created with the SCIM API are automatically created in Postman: - If the account's email ID does not exist, the user is also added to their organization's Postmanteam. - If the account's email ID already exists, the system sends the user an email invite to join thePostman team. After they accept the invite, the are added to the team. - By default, new users are given the developer role in Postman. Postman user roles cannot be updated via the SCIM API. You must manage user and group roles in Postman.
This API exposes 5 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
APIs.io Engineering Platform User Provisioning API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The User Provisioning endpoints enable you to provision and manage your Postman users. - You can only deactivate users with the SCIM API. You cannot permanently delete users with…
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are scimUserResource (7 properties), scimUserResources (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.