All Downloads are FREE. Search and download functionalities are using the official Maven repository.

swagger.api-identities-swagger.json Maven / Gradle / Ivy

There is a newer version: 8.4.5
Show newest version
{
  "swagger" : "2.0",
  "info" : {
    "description" : "MOLGENIS is a collaborative open source project on a mission to generate great software\n    infrastructure for life\n    science research",
    "version" : "8.2.4",
    "title" : "api-identities"
  },
  "basePath" : "/api",
  "tags" : [ {
    "name" : "Group"
  } ],
  "paths" : {
    "/api/identities/group" : {
      "get" : {
        "tags" : [ "Group" ],
        "summary" : "Get list with groups",
        "description" : "",
        "operationId" : "getGroups",
        "responses" : {
          "200" : {
            "description" : "List of groupResponse object available to user"
          }
        }
      },
      "post" : {
        "tags" : [ "Group" ],
        "summary" : "Create a new group",
        "description" : "",
        "operationId" : "createGroup",
        "parameters" : [ {
          "in" : "body",
          "name" : "body",
          "required" : false,
          "schema" : {
            "$ref" : "#/definitions/GroupCommand"
          }
        } ],
        "responses" : {
          "201" : {
            "description" : "New group created",
            "schema" : {
              "$ref" : "#/definitions/ResponseEntity"
            }
          },
          "400" : {
            "description" : "Group name not available",
            "schema" : {
              "$ref" : "#/definitions/ResponseEntity"
            }
          }
        }
      }
    },
    "/api/identities/group/{groupName}" : {
      "delete" : {
        "tags" : [ "Group" ],
        "summary" : "Delete a group",
        "description" : "",
        "operationId" : "deleteGroup",
        "parameters" : [ {
          "name" : "groupName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : "Group deleted",
            "schema" : {
              "$ref" : "#/definitions/ResponseEntity"
            }
          }
        }
      }
    },
    "/api/identities/group/{groupName}/member" : {
      "get" : {
        "tags" : [ "Group" ],
        "summary" : "Get group members",
        "description" : "",
        "operationId" : "getMembers",
        "parameters" : [ {
          "name" : "groupName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "type" : "array",
              "items" : {
                "type" : "object"
              }
            }
          }
        }
      },
      "post" : {
        "tags" : [ "Group" ],
        "summary" : "Add member to group",
        "description" : "",
        "operationId" : "addMember",
        "parameters" : [ {
          "name" : "groupName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "in" : "body",
          "name" : "body",
          "required" : false,
          "schema" : {
            "$ref" : "#/definitions/AddGroupMemberCommand"
          }
        } ],
        "responses" : {
          "201" : {
            "description" : "Member added to group",
            "schema" : {
              "$ref" : "#/definitions/ResponseEntity"
            }
          }
        }
      }
    },
    "/api/identities/group/{groupName}/member/{memberName}" : {
      "put" : {
        "tags" : [ "Group" ],
        "summary" : "Change membership role",
        "description" : "",
        "operationId" : "updateMember",
        "parameters" : [ {
          "name" : "groupName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "memberName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "in" : "body",
          "name" : "body",
          "required" : false,
          "schema" : {
            "$ref" : "#/definitions/UpdateGroupMemberCommand"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Updated membership role",
            "schema" : {
              "$ref" : "#/definitions/ResponseEntity"
            }
          }
        }
      },
      "delete" : {
        "tags" : [ "Group" ],
        "summary" : "Remove member from group",
        "description" : "",
        "operationId" : "removeMember",
        "parameters" : [ {
          "name" : "groupName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "memberName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : "Member removed from group",
            "schema" : {
              "$ref" : "#/definitions/ResponseEntity"
            }
          }
        }
      }
    },
    "/api/identities/group/{groupName}/permission" : {
      "get" : {
        "tags" : [ "Group" ],
        "summary" : "Get group permissions",
        "description" : "",
        "operationId" : "getPermissions",
        "parameters" : [ {
          "name" : "groupName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "List of permissions for current user on group",
            "schema" : {
              "type" : "array",
              "items" : {
                "type" : "object"
              }
            }
          }
        }
      }
    },
    "/api/identities/group/{groupName}/role" : {
      "get" : {
        "tags" : [ "Group" ],
        "summary" : "Get group roles",
        "description" : "",
        "operationId" : "getGroupRoles",
        "parameters" : [ {
          "name" : "groupName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "type" : "array",
              "items" : {
                "type" : "object"
              }
            }
          }
        }
      }
    },
    "/api/identities/group/{groupName}/role/{roleName}" : {
      "put" : {
        "tags" : [ "Group" ],
        "summary" : "Change group role extension",
        "description" : "",
        "operationId" : "updateExtends",
        "parameters" : [ {
          "name" : "groupName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "roleName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "in" : "body",
          "name" : "body",
          "required" : false,
          "schema" : {
            "$ref" : "#/definitions/UpdateIncludeCommand"
          }
        } ],
        "responses" : {
          "204" : {
            "description" : "Updated membership role",
            "schema" : {
              "$ref" : "#/definitions/ResponseEntity"
            }
          }
        }
      },
      "delete" : {
        "tags" : [ "Group" ],
        "summary" : "Remove extension from a grouprole from a role",
        "description" : "",
        "operationId" : "removeExtends",
        "parameters" : [ {
          "name" : "groupName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "roleName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : "Group role extension removed from role",
            "schema" : {
              "$ref" : "#/definitions/ResponseEntity"
            }
          }
        }
      }
    },
    "/api/identities/user" : {
      "get" : {
        "tags" : [ "Group" ],
        "summary" : "Get all users",
        "description" : "",
        "operationId" : "getUsers",
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "type" : "array",
              "items" : {
                "type" : "object"
              }
            }
          }
        }
      }
    }
  },
  "definitions" : {
    "AddGroupMemberCommand" : {
      "type" : "object",
      "properties" : {
        "username" : {
          "type" : "string"
        },
        "roleName" : {
          "type" : "string"
        }
      }
    },
    "GroupCommand" : {
      "type" : "object",
      "properties" : {
        "name" : {
          "type" : "string"
        },
        "label" : {
          "type" : "string"
        }
      }
    },
    "ResponseEntity" : {
      "type" : "object",
      "properties" : {
        "headers" : {
          "type" : "object",
          "additionalProperties" : {
            "type" : "array",
            "items" : {
              "type" : "string"
            }
          }
        },
        "body" : {
          "type" : "object"
        },
        "statusCode" : {
          "type" : "string",
          "enum" : [ "CONTINUE", "SWITCHING_PROTOCOLS", "PROCESSING", "CHECKPOINT", "OK", "CREATED", "ACCEPTED", "NON_AUTHORITATIVE_INFORMATION", "NO_CONTENT", "RESET_CONTENT", "PARTIAL_CONTENT", "MULTI_STATUS", "ALREADY_REPORTED", "IM_USED", "MULTIPLE_CHOICES", "MOVED_PERMANENTLY", "FOUND", "MOVED_TEMPORARILY", "SEE_OTHER", "NOT_MODIFIED", "USE_PROXY", "TEMPORARY_REDIRECT", "PERMANENT_REDIRECT", "BAD_REQUEST", "UNAUTHORIZED", "PAYMENT_REQUIRED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "PROXY_AUTHENTICATION_REQUIRED", "REQUEST_TIMEOUT", "CONFLICT", "GONE", "LENGTH_REQUIRED", "PRECONDITION_FAILED", "PAYLOAD_TOO_LARGE", "REQUEST_ENTITY_TOO_LARGE", "URI_TOO_LONG", "REQUEST_URI_TOO_LONG", "UNSUPPORTED_MEDIA_TYPE", "REQUESTED_RANGE_NOT_SATISFIABLE", "EXPECTATION_FAILED", "I_AM_A_TEAPOT", "INSUFFICIENT_SPACE_ON_RESOURCE", "METHOD_FAILURE", "DESTINATION_LOCKED", "UNPROCESSABLE_ENTITY", "LOCKED", "FAILED_DEPENDENCY", "UPGRADE_REQUIRED", "PRECONDITION_REQUIRED", "TOO_MANY_REQUESTS", "REQUEST_HEADER_FIELDS_TOO_LARGE", "UNAVAILABLE_FOR_LEGAL_REASONS", "INTERNAL_SERVER_ERROR", "NOT_IMPLEMENTED", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "GATEWAY_TIMEOUT", "HTTP_VERSION_NOT_SUPPORTED", "VARIANT_ALSO_NEGOTIATES", "INSUFFICIENT_STORAGE", "LOOP_DETECTED", "BANDWIDTH_LIMIT_EXCEEDED", "NOT_EXTENDED", "NETWORK_AUTHENTICATION_REQUIRED" ]
        },
        "statusCodeValue" : {
          "type" : "integer",
          "format" : "int32"
        }
      }
    },
    "UpdateGroupMemberCommand" : {
      "type" : "object",
      "properties" : {
        "roleName" : {
          "type" : "string"
        }
      }
    },
    "UpdateIncludeCommand" : {
      "type" : "object",
      "properties" : {
        "role" : {
          "type" : "string"
        }
      }
    }
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy