{ "opencollection": "1.0.0", "info": { "name": "Postman SCIM API", "version": "1.0.0" }, "items": [ { "info": { "name": "scim", "type": "folder" }, "items": [ { "info": { "name": "Get all groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.postman.com/scim/v2/Groups", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "startIndex", "value": "", "type": "query", "description": "The index entry by which to begin the list of returned results. Must be a value of `1` or greater." }, { "name": "count", "value": "", "type": "query", "description": "Limit the number of results returned in a single response." }, { "name": "filter", "value": "", "type": "query", "description": "Filter results by a specific word or phrase. This query parameter only supports the `displayName` filter and has the following requirements:\n- Filter values are case-sensitive.\n- Special characters and spaces must be URL encoded.\n" } ] }, "docs": "Gets information about all Postman team members." }, { "info": { "name": "Create a group", "type": "http" }, "http": { "method": "POST", "url": "https://api.postman.com/scim/v2/Groups", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new user group in Postman and creates a new account for each group member.\n\nEach account is added to your Postman team and authentication is activated for each user. If an existing Postman account uses an email that matches a group member's email ID, an [email invite](https://postman.postman.co/docs/administration/managing-your-team/managing-your-team/#invites) to join your Postman team is sent to that user. Once the user accepts the invite, they'll be added to your team.\n\nBy default, " }, { "info": { "name": "Get a group", "type": "http" }, "http": { "method": "GET", "url": "https://api.postman.com/scim/v2/Groups/:groupId", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The group's ID." } ] }, "docs": "Gets information about a Postman group within the team." }, { "info": { "name": "Update a group", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.postman.com/scim/v2/Groups/:groupId", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The group's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a group's information. Using this endpoint you can:\n\n- Update a group's name.\n- Add or remove members from a Postman group.\n" }, { "info": { "name": "Delete a group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.postman.com/scim/v2/Groups/:groupId", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The group's ID." } ] }, "docs": "Deletes a group in Postman. On success, this returns an HTTP `204 No Content` response.\n\nUser accounts that were in the deleted group are deactivated in Postman if the app is assigned to the user only with the deleted group.\n\nUser accounts and the data corresponding to them are not deleted. To permanently delete user accounts and their data, [contact Postman support](https://www.postman.com/support/).\n" }, { "info": { "name": "Get resource types", "type": "http" }, "http": { "method": "GET", "url": "https://api.postman.com/scim/v2/ResourceTypes", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "Gets all the resource types supported by Postman's SCIM API." }, { "info": { "name": "Get service provider configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.postman.com/scim/v2/ServiceProviderConfig", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "Gets the Postman SCIM API configuration information. This includes a list of supported operations." }, { "info": { "name": "Get all users", "type": "http" }, "http": { "method": "GET", "url": "https://api.postman.com/scim/v2/Users", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "startIndex", "value": "", "type": "query", "description": "The index entry by which to begin the list of returned results. Must be a value of `1` or greater." }, { "name": "count", "value": "", "type": "query", "description": "Limit the number of results returned in a single response." }, { "name": "filter", "value": "", "type": "query", "description": "Filter results by a specific word or phrase. This query parameter accepts the following:\n- `userName` — Filter values are case-sensitive, and special characters and spaces must be URL encoded.\n- `active` — Return only users who are active (`true`) or inactive (`false`).\n" } ] }, "docs": "Gets information about all Postman team members." }, { "info": { "name": "Create a user", "type": "http" }, "http": { "method": "POST", "url": "https://api.postman.com/scim/v2/Users", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new user account in Postman and adds the user to your organization's Postman team.\n- If the account does not exist, this also activates the user so they can authenticate in to your Postman team.\n- If an account matching the email ID exists, the user receives [email invite](https://learning.postman.com/docs/administration/managing-your-team/manage-team-members/#manage-invites) to join the Postman team. The user joins the team when they accept the invite.\n- If the user's email domain mat" }, { "info": { "name": "Get a user", "type": "http" }, "http": { "method": "GET", "url": "https://api.postman.com/scim/v2/Users/:userId", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user's SCIM ID." } ] }, "docs": "Gets information about a Postman team member." }, { "info": { "name": "Update a user", "type": "http" }, "http": { "method": "PUT", "url": "https://api.postman.com/scim/v2/Users/:userId", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user's SCIM ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a user in Postman.\n\n**Reactivating a user**\n\nBy setting the `active` property from `false` to `true`, this reactivates an account. This allows the account to authenticate in to Postman and adds the account back on to your Postman team.\n" }, { "info": { "name": "Update a user", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.postman.com/scim/v2/Users/:userId", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user's SCIM ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a user in Postman.\n\n**Reactivating a user**\n\nBy setting the `active` property from `false` to `true`, this reactivates an account. This allows the account to authenticate in to Postman and adds the account back on to your Postman team.\n" } ] } ], "bundled": true }