{
  "openapi": "3.0.1",
  "info": {
    "title": "Role Assignment Permissions",
    "description": "Create and administer a collection of role assignment permissions.",
    "version": "9.1.20.0",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "paths": {
    "/role-assignment-permissions": {
      "get": {
        "tags": [
          "role-assignment-permissions"
        ],
        "description": "Get a collection of role assignment permissions.",
        "operationId": "getRoleAssignmentPermissions",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The role assignment permission ID.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "assigningRoleId",
            "in": "query",
            "description": "The assigning role ID",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "assignableRoleId",
            "in": "query",
            "description": "The assignable role ID",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "organizationId",
            "in": "query",
            "description": "The organization ID.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of role assignment permissions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RoleAssignmentPermissionCollection"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "role-assignment-permissions"
        ],
        "description": "Create a role assignment permission.",
        "operationId": "createRoleAssignmentPermission",
        "requestBody": {
          "description": "The role assignment permission.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RoleAssignmentPermission.request"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the role-assignment-permissions.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetRoleAssignmentPermissionsByroleId": {
                "operationRef": "#/paths/~1role-assignment-permissions~1{id}/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /role-assignment-permissions/{id}`.\n"
              },
              "DeleteRoleAssignmentPermissionsByroleId": {
                "operationRef": "#/paths/~1role-assignment-permissions~1{id}/delete",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `DELETE /role-assignment-permissions/{id}`.\n"
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "RoleAssignmentPermission"
      }
    },
    "/role-assignment-permissions/{id}": {
      "get": {
        "tags": [
          "role-assignment-permissions"
        ],
        "description": "Get a role assignment permission ID.",
        "operationId": "getRoleAssignmentPermissionById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The role assignment permission ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The role assignment permission.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RoleAssignmentPermission"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "role-assignment-permissions"
        ],
        "description": "Delete a role assignment permission.",
        "operationId": "deleteRoleAssignmentPermissionById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The role assignment permission ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Link": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The URL of the link.",
            "format": "uri"
          }
        },
        "description": "Links to related resources."
      },
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "description": "The error message code."
          },
          "errorMessage": {
            "type": "string",
            "description": "The error message."
          },
          "errorKey": {
            "type": "string",
            "description": "The error message key."
          },
          "errorParameters": {
            "type": "array",
            "description": "The arguments used to construct the error message.",
            "items": {
              "type": "object",
              "properties": {}
            }
          },
          "errorLevel": {
            "type": "string",
            "description": "The error level."
          },
          "errorHref": {
            "type": "string",
            "description": "The error hypertext reference."
          }
        },
        "description": "The error message item model."
      },
      "ErrorResponseContainer": {
        "type": "object",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "The request identifier."
          },
          "errors": {
            "type": "array",
            "description": "The errors.",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        },
        "description": "The error message model."
      },
      "RoleAssignmentPermission": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The role assignment permission ID.",
            "format": "int64"
          },
          "assigningRoleId": {
            "type": "integer",
            "description": "The assigning role ID",
            "format": "int32"
          },
          "assignableRoleId": {
            "type": "integer",
            "description": "The assignable role ID",
            "format": "int32"
          },
          "organizationId": {
            "type": "integer",
            "description": "The organization ID.",
            "format": "int64"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "The role assignment permission."
      },
      "RoleAssignmentPermission.request": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The role assignment permission ID.",
            "format": "int64"
          },
          "assigningRoleId": {
            "type": "integer",
            "description": "The assigning role ID",
            "format": "int32"
          },
          "assignableRoleId": {
            "type": "integer",
            "description": "The assignable role ID",
            "format": "int32"
          },
          "organizationId": {
            "type": "integer",
            "description": "The organization ID.",
            "format": "int64"
          }
        },
        "description": "The role assignment permission."
      },
      "RoleAssignmentPermissionCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/RoleAssignmentPermission"
            }
          }
        },
        "description": "A collection of role assignment permissions."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}