{
  "opencollection": "1.0.0",
  "info": {
    "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Roles API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Roles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "APIs.io Engineering Platform Get a collection's roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/roles",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's ID."
              }
            ]
          },
          "docs": "Gets information about all roles in a collection. The response returns the IDs of all users, teams, and groups with access to view or edit the collection."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Update a collection's roles",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/roles",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the roles of users, groups, or teams in a collection. On success, this returns an HTTP `204 No Content` response.\n\n**Note:**\n\n- Only users assigned the EDITOR [role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#collection-roles) in the collection can use this endpoint.\n- This endpoint does not support the external [Partner or Guest roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).\n"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get all roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/workspaces-roles"
          },
          "docs": "Gets information about all roles in a workspace, based on the team's [plan](https://www.postman.com/pricing/).\n"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get a workspace's roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/workspaces/:workspaceId/roles",
            "params": [
              {
                "name": "workspaceId",
                "value": "",
                "type": "path",
                "description": "The workspace's ID."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include the following information in the endpoint's response:\n- `scim` — Return IDs as SCIM user and group IDs.\n"
              }
            ]
          },
          "docs": "Gets the roles of users and user groups in a workspace:\n- `Viewer` — Can view, fork, and export workspace resources.\n- `Editor` — Can create and edit workspace resources.\n- `Admin` — Can manage workspace details and members.\n"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Update user or user group roles",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://apigateway.{region}.amazonaws.com/workspaces/:workspaceId/roles",
            "headers": [
              {
                "name": "identifierType",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspaceId",
                "value": "",
                "type": "path",
                "description": "The workspace's ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the roles of [users](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) or [user groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/) in a workspace. To get a list of roles, use the `GET /workspace-roles` endpoint.\n\n**Note:**\n\n- To use SCIM IDs, include the `identifierType=scim` header when you call this endpoint. To get SCIM user IDs, include the `include=scim` query parameter when calling the GET `/workspaces/{works"
        }
      ]
    }
  ],
  "bundled": true
}