Package org.apache.polaris.service.admin.api

Class PolarisPrincipalRolesApi

java.lang.Object
org.apache.polaris.service.admin.api.PolarisPrincipalRolesApi
@Path("/api/management/v1/principal-roles") @Generated(value="org.openapitools.codegen.languages.JavaResteasyServerCodegen", date="2025-10-06T09:01:49.455628396Z[UTC]", comments="Generator version: 7.12.0") public class PolarisPrincipalRolesApi extends Object
The principal-roles API interface This file is automatically generated by the OpenAPI Code Generator based on configuration in the build.gradle file.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PolarisPrincipalRolesApi(PolarisPrincipalRolesApiService service)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    assignCatalogRoleToPrincipalRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String principalRoleName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Valid org.apache.polaris.core.admin.model.GrantCatalogRoleRequest grantCatalogRoleRequest, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Assign a catalog role to a principal role Response type: Void.
    jakarta.ws.rs.core.Response
    createPrincipalRole(@Valid org.apache.polaris.core.admin.model.CreatePrincipalRoleRequest createPrincipalRoleRequest, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Create a principal role Response type: Void.
    jakarta.ws.rs.core.Response
    deletePrincipalRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String principalRoleName, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Remove a principal role from polaris Response type: Void.
    jakarta.ws.rs.core.Response
    getPrincipalRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String principalRoleName, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Get the principal role details Response type: PrincipalRole.
    jakarta.ws.rs.core.Response
    listAssigneePrincipalsForPrincipalRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String principalRoleName, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    List the Principals to whom the target principal role has been assigned Response type: Principals.
    jakarta.ws.rs.core.Response
    listCatalogRolesForPrincipalRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String principalRoleName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Get the catalog roles mapped to the principal role Response type: CatalogRoles.
    jakarta.ws.rs.core.Response
    listPrincipalRoles(org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    List the principal roles Response type: PrincipalRoles.
    jakarta.ws.rs.core.Response
    revokeCatalogRoleFromPrincipalRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String principalRoleName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Remove a catalog role from a principal role Response type: Void.
    jakarta.ws.rs.core.Response
    updatePrincipalRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String principalRoleName, @Valid org.apache.polaris.core.admin.model.UpdatePrincipalRoleRequest updatePrincipalRoleRequest, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Update an existing principalRole Response type: PrincipalRole.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • assignCatalogRoleToPrincipalRole

      @PUT @Path("/{principalRoleName}/catalog-roles/{catalogName}") @Consumes("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response assignCatalogRoleToPrincipalRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("principalRoleName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String principalRoleName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Nonnull @Valid @Valid org.apache.polaris.core.admin.model.GrantCatalogRoleRequest grantCatalogRoleRequest, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Assign a catalog role to a principal role Response type: Void.
      Parameters:
      principalRoleName - Required - The principal role name
      catalogName - Required - The name of the catalog where the catalogRoles reside
      grantCatalogRoleRequest - Required - The principal to create
      Returns:
      201 - Successful response

    • createPrincipalRole

      @POST @Consumes("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response createPrincipalRole(@Nonnull @Valid @Valid org.apache.polaris.core.admin.model.CreatePrincipalRoleRequest createPrincipalRoleRequest, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Create a principal role Response type: Void.
      Parameters:
      createPrincipalRoleRequest - Required - The principal to create
      Returns:
      201 - Successful response

    • deletePrincipalRole

      @DELETE @Path("/{principalRoleName}") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response deletePrincipalRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("principalRoleName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String principalRoleName, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Remove a principal role from polaris Response type: Void.
      Parameters:
      principalRoleName - Required - The principal role name
      Returns:
      204 - Success, no content

    • getPrincipalRole

      @GET @Path("/{principalRoleName}") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response getPrincipalRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("principalRoleName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String principalRoleName, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Get the principal role details Response type: PrincipalRole.
      Parameters:
      principalRoleName - Required - The principal role name
      Returns:
      200 - The requested principal role

    • listAssigneePrincipalsForPrincipalRole

      @GET @Path("/{principalRoleName}/principals") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response listAssigneePrincipalsForPrincipalRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("principalRoleName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String principalRoleName, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      List the Principals to whom the target principal role has been assigned Response type: Principals.
      Parameters:
      principalRoleName - Required - The principal role name
      Returns:
      200 - List the Principals to whom the target principal role has been assigned

    • listCatalogRolesForPrincipalRole

      @GET @Path("/{principalRoleName}/catalog-roles/{catalogName}") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response listCatalogRolesForPrincipalRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("principalRoleName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String principalRoleName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Get the catalog roles mapped to the principal role Response type: CatalogRoles.
      Parameters:
      principalRoleName - Required - The principal role name
      catalogName - Required - The name of the catalog where the catalogRoles reside
      Returns:
      200 - The list of catalog roles mapped to the principal role

    • listPrincipalRoles

      @GET @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response listPrincipalRoles(@Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      List the principal roles Response type: PrincipalRoles.
      Returns:
      200 - List of principal roles

    • revokeCatalogRoleFromPrincipalRole

      @DELETE @Path("/{principalRoleName}/catalog-roles/{catalogName}/{catalogRoleName}") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response revokeCatalogRoleFromPrincipalRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("principalRoleName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String principalRoleName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogRoleName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Remove a catalog role from a principal role Response type: Void.
      Parameters:
      principalRoleName - Required - The principal role name
      catalogName - Required - The name of the catalog that contains the role to revoke
      catalogRoleName - Required - The name of the catalog role that should be revoked
      Returns:
      204 - Success, no content

    • updatePrincipalRole

      @PUT @Path("/{principalRoleName}") @Consumes("application/json") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response updatePrincipalRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("principalRoleName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String principalRoleName, @Nonnull @Valid @Valid org.apache.polaris.core.admin.model.UpdatePrincipalRoleRequest updatePrincipalRoleRequest, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Update an existing principalRole Response type: PrincipalRole.
      Parameters:
      principalRoleName - Required - The principal role name
      updatePrincipalRoleRequest - Required - The principalRole details to use in the update
      Returns:
      200 - The updated principal role