openapi: 3.0.0
info:
version: 2015-07-09
x-release: v4
title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Group Provisioning API
description:
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Group Provisioning description: The **Group Provisioning** endpoints enable you to provision and manage your Postman groups. paths: /scim/v2/Groups: get: summary: APIs.io Engineering Platform Get all group resources description: Gets information about all Postman team members. operationId: getScimGroupResources x-postman-plan: Enterprise tags: - Group Provisioning responses: '200': $ref: '#/components/responses/getScimGroupResources' '400': $ref: '#/components/responses/scim400ErrorInvalidFilter' '401': $ref: '#/components/responses/scim401Error' '403': $ref: '#/components/responses/scim403Error' '500': $ref: '#/components/responses/scimGroup500Error' parameters: - $ref: '#/components/parameters/startIndex' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/scimGroupFilter' post: summary: APIs.io Engineering Platform Create a group description: 'Creates a new user group in Postman and creates a new account for each group member. Each 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. By default, the system assigns new users the developer role. You can [update user roles in Postman](https://learning.postman.com/docs/administration/managing-your-team/managing-your-team/#managing-team-roles). ' operationId: createScimGroup x-postman-plan: Enterprise tags: - Group Provisioning requestBody: $ref: '#/components/requestBodies/createScimGroup' responses: '201': $ref: '#/components/responses/createScimGroup' '400': $ref: '#/components/responses/scim400ErrorInvalidSyntax' '401': $ref: '#/components/responses/scim401Error' '403': $ref: '#/components/responses/scim403Error' '409': $ref: '#/components/responses/scim409Error' '500': $ref: '#/components/responses/scimUpdateGroup500Error' /scim/v2/Groups/{groupId}: parameters: - $ref: '#/components/parameters/scimGroupId' get: summary: APIs.io Engineering Platform Get a group resource description: Gets information about a Postman group within the team. operationId: getScimGroupResource x-postman-plan: Enterprise tags: - Group Provisioning responses: '200': $ref: '#/components/responses/getScimGroupResource' '400': $ref: '#/components/responses/scim400Error' '401': $ref: '#/components/responses/scim401Error' '403': $ref: '#/components/responses/scim403Error' '404': $ref: '#/components/responses/scimGroup404Error' '500': $ref: '#/components/responses/scim500Error' patch: summary: APIs.io Engineering Platform Update a group description: 'Updates a group''s information. Using this endpoint you can: - Update a group''s name. - Add or remove members from a Postman group. ' operationId: scimUpdateGroup x-postman-plan: Enterprise tags: - Group Provisioning requestBody: $ref: '#/components/requestBodies/scimUpdateGroup' responses: '200': $ref: '#/components/responses/scimUpdateGroup' '400': $ref: '#/components/responses/scim400ErrorInvalidSyntax' '401': $ref: '#/components/responses/scim401Error' '403': $ref: '#/components/responses/scim403Error' '404': $ref: '#/components/responses/scimGroup404Error' '500': $ref: '#/components/responses/scim500Error' delete: summary: APIs.io Engineering Platform Delete a group description: 'Deletes a group in Postman. On success, this returns an HTTP `204 No Content` response. User accounts that were in the deleted group are deactivated in Postman if the app is assigned to the user only with the deleted group. User 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/). ' operationId: deleteScimGroup x-postman-plan: Enterprise tags: - Group Provisioning responses: '204': description: Group Deleted '400': $ref: '#/components/responses/scim400Error' '401': $ref: '#/components/responses/scim401Error' '403': $ref: '#/components/responses/scim403Error' '404': $ref: '#/components/responses/scimGroup404Error' '500': $ref: '#/components/responses/scim500Error' components: parameters: scimGroupFilter: name: filter in: query description: 'Filter results by a specific word or phrase. This query parameter only supports the `displayName` filter and has the following requirements: - Filter values are case-sensitive. - Special characters and spaces must be URL encoded. ' schema: type: string example: displayName eq "Test-API" scimGroupId: name: groupId in: path required: true description: The group's ID. schema: $ref: '#/components/schemas/scimId' count: name: count in: query description: Limit the number of results returned in a single response. schema: type: number default: 100 example: 2 startIndex: name: startIndex in: query description: The index entry by which to begin the list of returned results. schema: type: number default: 1 example: 1 schemas: scimGroupResource: title: SCIM Group Resource description: The SCIM group resource object. type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:schemas:core:2.0:Group id: type: string description: The group's SCIM ID. example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 displayName: type: string description: The group's display name. example: Test SCIMv2 members: type: array description: A list of the group's members. items: type: object description: Information about the group's members. properties: value: type: string description: The resource value. example: 23a35c2723d34c03b4c56443c09e7173 display: type: string description: The resource's display name. example: taylor.lee@example.com externalId: type: string description: The group's external ID. example: '1234' meta: type: object description: The response's non-standard meta information. properties: resourceType: type: string description: The resource type. example: Group created: type: string format: date-time description: The date and time at which the group was created. example: '2022-02-22T04:24:13.000Z' lastModified: type: string format: date-time description: The date and time at which the group was last modified. example: '2022-02-22T04:24:13.000Z' scimId: type: string example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 responses: getScimGroupResource: description: Successful Response content: application/json: schema: type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:schemas:core:2.0:Group id: type: string description: The group's SCIM ID. example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 userName: type: string description: The group's display name. example: Test-API members: type: array description: Information about the group's members. items: type: object properties: value: type: string description: The member's SCIM ID. example: 23a35c2723d34c03b4c56443c09e7173 display: type: string description: The member's display name. example: Taylor Lee externalId: type: string description: The group's external ID. example: '1234' meta: type: object description: The response's non-standard meta information. properties: resourceType: type: string description: The resource type. example: Group created: type: string format: date-time description: The date and time at which the group was created. example: '2022-02-22T04:24:13.000Z' lastModified: type: string format: date-time description: The date and time at which the group was last modified. example: '2022-02-22T04:24:13.000Z' example: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 displayName: Test-API members: - value: 23a35c2723d34c03b4c56443c09e7173 display: Taylor Lee externalId: '1234' meta: resourceType: Group created: '2022-02-22T04:24:13.000Z' lastModified: '2022-02-22T04:24:13.000Z' scim400Error: description: Bad Request content: application/json: schema: type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:api:messages:2.0:Error detail: type: string description: Information about the error. example: This Postman team doesn't exist anymore. status: type: string format: http-status-code description: The HTTP status code. example: '400' example: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: This Postman team doesn't exist anymore. status: '400' scim500Error: description: Internal Server Error content: application/json: schema: type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:api:messages:2.0:Error detail: type: string description: Information about the error. example: Couldn't update this team member's information. Try again — it should work next time around. status: type: string format: http-status-code description: The HTTP status code. example: '500' example: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: Couldn't update this team member's information. Try again — it should work next time around. status: '500' scimUpdateGroup: description: Successful Response content: application/json: schema: type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:api:messages:2.0:PatchOp id: type: string description: The group's ID. example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 displayName: type: string description: The group's name. example: Test-API externalId: type: string description: The group's external ID. example: '1234' meta: type: object description: The response's non-standard meta information. properties: resourceType: type: string description: The resource type. example: Group created: type: string format: date-time description: The date and time at which the group was created. example: '2022-02-22T04:24:13.000Z' lastModified: type: string format: date-time description: The date and time at which the group was last modified. example: '2022-02-22T04:24:13.000Z' example: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 displayName: Test-API members: - value: 23a35c2723d34c03b4c56443c09e7173 display: Taylor Lee externalId: '1234' meta: resourceType: Group created: '2022-02-22T04:24:13.000Z' lastModified: '2022-02-22T04:24:13.000Z' scimGroup404Error: description: Not Found content: application/json: schema: type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:api:messages:2.0:Error detail: type: string description: Information about the error. example: This group isn't a member of the team. status: type: string format: http-status-code description: The HTTP status code. example: '404' example: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: This group isn't a member of the team. status: '404' createScimGroup: description: Created content: application/json: schema: type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:schemas:core:2.0:Group id: type: string description: The group's SCIM ID. example: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00 displayName: type: string description: The group's display name. example: Test-API externalId: type: string description: The group's external ID. example: '1234' members: type: array items: type: object description: An object containing the group's assigned SCIM members. properties: value: type: string description: The user's SCIM ID. example: 23a35c2723d34c03b4c56443c09e7173 display: type: string description: The user's display name. example: Taylor Lee meta: type: object description: The response's non-standard meta information. properties: created: type: string format: date-time description: The date and time at which the group was created. example: '2021-02-22T04:24:13.000Z' lastModified: type: string format: date-time description: The date and time at which the group was last modified. example: '2021-02-22T04:24:13.000Z' resourceType: type: string description: The SCIM resource type. example: Group example: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group id: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00 displayName: Test-API externalId: '1234' members: - value: 23a35c2723d34c03b4c56443c09e7173 display: Taylor Lee meta: created: '2022-02-22T04:24:13.000Z' lastModified: '2022-02-22T04:24:13.000Z' resourceType: Group scim401Error: description: Unauthorized content: application/json: schema: type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:api:messages:2.0:Error detail: type: string description: Information about the error. example: Unable to access the team. Check if you have entered a valid API key. status: type: string format: http-status-code description: The HTTP status code. example: '401' example: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: Unable to access the team. Check if you have entered a valid API key. status: '401' scim403Error: description: Forbidden content: application/json: schema: type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:api:messages:2.0:Error detail: type: string description: Information about the error. example: Your API key was generated by a Team Admin who is no longer on your team. Use an API key generated by a Team Admin. status: type: string format: http-status-code description: The HTTP status code. example: '403' example: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: Your API key was generated by a Team Admin who is no longer on your team. Use an API key generated by a Team Admin. status: '403' getScimGroupResources: description: Successful Response content: application/json: schema: type: object properties: Resources: type: array description: A list of group resources. items: $ref: '#/components/schemas/scimGroupResource' itemsPerPage: type: number description: The number of items per response page. example: 2 schemas: type: array items: type: string description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). example: urn:ietf:params:scim:api:messages:2.0:ListResponse startIndex: type: number description: The index entry by which the returned results begin. example: 1 totalResults: type: number description: The total number of results found. example: 2 example: schemas: - urn:ietf:params:scim:api:messages:2.0:ListResponse totalResults: 2 startIndex: 1 itemsPerPage: 2 Resources: - schemas: - urn:ietf:params:scim:schemas:core:2.0:Group id: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00 displayName: Test-API members: - value: 23a35c2723d34c03b4c56443c09e7173 display: Taylor Lee externalId: '1234' meta: resourceType: Group created: '2022-02-22T04:24:13.000Z' lastModified: '2022-02-22T04:24:13.000Z' - schemas: - urn:ietf:params:scim:schemas:core:2.0:Group id: 123775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 displayName: Test Group members: - value: 23a35c2723d34c03b4c56443c09e7173 display: Taylor Lee - value: b1c794f24f4c49f4b5d503a4cb2686ea display: Alex Cruz externalId: '4321' meta: resourceType: Group created: '2022-02-22T04:24:13.000Z' lastModified: '2022-02-22T04:24:13.000Z' scimUpdateGroup500Error: description: Internal Server Error content: application/json: schema: type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:api:messages:2.0:Error detail: type: string description: Information about the error. example: Couldn't update this team member's information. Try again — it should work next time around. status: type: string format: http-status-code description: The HTTP status code. example: '500' example: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: Couldn't update this team member's information. Try again — it should work next time around. status: '500' scim400ErrorInvalidFilter: description: Bad Request content: application/json: schema: type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:api:messages:2.0:Error detail: type: string description: Information about the error. example: You've used filter(s) that Postman doesn't support. status: type: string format: http-status-code description: The HTTP status code. example: '400' example: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: You've used filter(s) that Postman doesn't support. status: '400' scim409Error: description: Conflict content: application/json: schema: type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:api:messages:2.0:Error scimType: type: string description: The SCIM error type. example: uniqueness detail: type: string description: Information about the error. example: This person is already a member of the team. status: type: string format: http-status-code description: The HTTP status code. example: '409' example: schemas: - urn:ietf:params:scim:api:messages:2.0:Error scimType: uniqueness detail: This person is already a member of the team. status: '409' scim400ErrorInvalidSyntax: description: Bad Request content: application/json: schema: type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:api:messages:2.0:Error scimType: type: string description: The SCIM error type. example: invalidSyntax detail: type: string description: Information about the error. example: The request body seems to be incomplete or have unsupported characters. status: type: string format: http-status-code description: The HTTP status code. example: '400' example: schemas: - urn:ietf:params:scim:api:messages:2.0:Error scimType: invalidSyntax detail: The request body seems to be incomplete or have unsupported characters. status: '400' scimGroup500Error: description: Internal Server Error content: application/json: schema: type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:api:messages:2.0:Error detail: type: string description: Information about the error. example: Couldn't fetch members of the team. status: type: string format: http-status-code description: The HTTP status code. example: '500' example: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: Couldn't fetch members of the team. status: '500' requestBodies: scimUpdateGroup: content: application/json: schema: type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: type: array description: Information about the group update operation. items: type: object properties: op: type: string description: The operation to perform. enum: - replace - remove - add example: replace path: type: string description: The operation's path. Include this value when you update a group's members. example: members value: type: object description: The performed operation's value. properties: id: type: string description: The group's ID. example: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00 displayName: type: string description: The group's name. example: Test-API example: schemas: - urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: - op: replace value: id: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00 displayName: Test-API createScimGroup: content: application/json: schema: type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:schemas:core:2.0:Group displayName: type: string description: The group's display name. example: Test-API members: type: array items: type: object description: An object containing the SCIM users to assign to the group. properties: value: type: string description: The user's SCIM ID. example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 display: type: string description: The user's display name. example: Taylor Lee example: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group displayName: Test-API members: - value: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 displayName: Taylor Lee securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true