@tapis/tapis-typescript-sk 0.0.2

package/dist/apis/UserApi.d.ts

@@ -0,0 +1,276 @@
+/**
+ * Tapis Security API
+ * The Tapis Security API provides access to the Tapis Security Kernel authorization and secrets facilities.
+ *
+ * The version of the OpenAPI document: 0.1
+ * Contact: cicsupport@tacc.utexas.edu
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import { ReqGrantAdminRole, ReqGrantUserPermission, ReqGrantUserRole, ReqGrantUserRoleWithPermission, ReqRevokeAdminRole, ReqRevokeUserPermission, ReqRevokeUserRole, ReqUserHasRole, ReqUserHasRoleMulti, ReqUserIsAdmin, ReqUserIsPermitted, ReqUserIsPermittedMulti, RespAuthorized, RespChangeCount, RespName, RespNameArray } from '../models';
+export interface GetAdminsRequest {
+    tenant: string;
+    pretty?: boolean;
+}
+export interface GetDefaultUserRole1Request {
+    user: string;
+    pretty?: boolean;
+}
+export interface GetUserNamesRequest {
+    tenant?: string;
+    pretty?: boolean;
+}
+export interface GetUserPermsRequest {
+    user: string;
+    tenant?: string;
+    implies?: string;
+    impliedBy?: string;
+    pretty?: boolean;
+}
+export interface GetUserRolesRequest {
+    user: string;
+    tenant?: string;
+    pretty?: boolean;
+}
+export interface GetUsersWithPermissionRequest {
+    permSpec: string;
+    tenant?: string;
+    pretty?: boolean;
+}
+export interface GetUsersWithRoleRequest {
+    roleName: string;
+    tenant?: string;
+    pretty?: boolean;
+}
+export interface GrantAdminRoleRequest {
+    reqGrantAdminRole: ReqGrantAdminRole;
+    pretty?: boolean;
+}
+export interface GrantRoleRequest {
+    reqGrantUserRole: ReqGrantUserRole;
+    pretty?: boolean;
+}
+export interface GrantRoleWithPermissionRequest {
+    reqGrantUserRoleWithPermission: ReqGrantUserRoleWithPermission;
+    pretty?: boolean;
+}
+export interface GrantUserPermissionRequest {
+    reqGrantUserPermission: ReqGrantUserPermission;
+    pretty?: boolean;
+}
+export interface HasRoleRequest {
+    reqUserHasRole: ReqUserHasRole;
+    pretty?: boolean;
+}
+export interface HasRoleAllRequest {
+    reqUserHasRoleMulti: ReqUserHasRoleMulti;
+    pretty?: boolean;
+}
+export interface HasRoleAnyRequest {
+    reqUserHasRoleMulti: ReqUserHasRoleMulti;
+    pretty?: boolean;
+}
+export interface IsAdminRequest {
+    reqUserIsAdmin: ReqUserIsAdmin;
+    pretty?: boolean;
+}
+export interface IsPermittedRequest {
+    reqUserIsPermitted: ReqUserIsPermitted;
+    pretty?: boolean;
+}
+export interface IsPermittedAllRequest {
+    reqUserIsPermittedMulti: ReqUserIsPermittedMulti;
+    pretty?: boolean;
+}
+export interface IsPermittedAnyRequest {
+    reqUserIsPermittedMulti: ReqUserIsPermittedMulti;
+    pretty?: boolean;
+}
+export interface RevokeAdminRoleRequest {
+    reqRevokeAdminRole: ReqRevokeAdminRole;
+    pretty?: boolean;
+}
+export interface RevokeUserPermissionRequest {
+    reqRevokeUserPermission: ReqRevokeUserPermission;
+    pretty?: boolean;
+}
+export interface RevokeUserRoleRequest {
+    reqRevokeUserRole: ReqRevokeUserRole;
+    pretty?: boolean;
+}
+/**
+ *
+ */
+export declare class UserApi extends runtime.BaseAPI {
+    /**
+     * Get all users assigned the tenant administrator role ($!tenant_admin).  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    getAdminsRaw(requestParameters: GetAdminsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespNameArray>>;
+    /**
+     * Get all users assigned the tenant administrator role ($!tenant_admin).  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    getAdmins(requestParameters: GetAdminsRequest, initOverrides?: RequestInit): Promise<RespNameArray>;
+    /**
+     * Get a user\'s default role. The default role is implicitly created by the system when needed if it doesn\'t already exist. No authorization required.  A user\'s default role is constructed by prepending \'$$\' to the user\'s name.  This implies the maximum length of a user name is 58 since role names are limited to 60 characters.
+     */
+    getDefaultUserRole1Raw(requestParameters: GetDefaultUserRole1Request, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespName>>;
+    /**
+     * Get a user\'s default role. The default role is implicitly created by the system when needed if it doesn\'t already exist. No authorization required.  A user\'s default role is constructed by prepending \'$$\' to the user\'s name.  This implies the maximum length of a user name is 58 since role names are limited to 60 characters.
+     */
+    getDefaultUserRole1(requestParameters: GetDefaultUserRole1Request, initOverrides?: RequestInit): Promise<RespName>;
+    /**
+     * Get the names of all users in the tenant that have been granted a role or permission.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    getUserNamesRaw(requestParameters: GetUserNamesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespNameArray>>;
+    /**
+     * Get the names of all users in the tenant that have been granted a role or permission.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    getUserNames(requestParameters: GetUserNamesRequest, initOverrides?: RequestInit): Promise<RespNameArray>;
+    /**
+     * Get the permissions assigned to a user in a tenant, including those assigned transively.  The result list can be optionally filtered by the one or both of the query parameters: implies and impliedBy.  The implied parameter removes permissions from the result list that the specified permission do not imply. The impliedBy parameter removes permissions from the result list that the specified permission are not implied by. Below are some examples.Consider a user that is assigned these permissions:      stream:dev:read:project1     stream:dev:read,write:project1     stream:dev:read,write,exec:project1  **Using the *implies* Query Parameter**  When _implies=stream:dev:*:project1_, this endpoint returns:      stream:dev:read:project1     stream:dev:read,write:project1     stream:dev:read,write,exec:project1  When _implies=stream:dev:write:project1_, this endpoint returns an empty list.  **Using the *impliedBy* Query Parameter**  When _impliedBy=stream:dev:*:project1_, this endpoint returns an empty list.  When _impliedBy=stream:dev:write:project1_, this endpoint returns:      stream:dev:read,write:project1     stream:dev:read,write,exec:project1  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    getUserPermsRaw(requestParameters: GetUserPermsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespNameArray>>;
+    /**
+     * Get the permissions assigned to a user in a tenant, including those assigned transively.  The result list can be optionally filtered by the one or both of the query parameters: implies and impliedBy.  The implied parameter removes permissions from the result list that the specified permission do not imply. The impliedBy parameter removes permissions from the result list that the specified permission are not implied by. Below are some examples.Consider a user that is assigned these permissions:      stream:dev:read:project1     stream:dev:read,write:project1     stream:dev:read,write,exec:project1  **Using the *implies* Query Parameter**  When _implies=stream:dev:*:project1_, this endpoint returns:      stream:dev:read:project1     stream:dev:read,write:project1     stream:dev:read,write,exec:project1  When _implies=stream:dev:write:project1_, this endpoint returns an empty list.  **Using the *impliedBy* Query Parameter**  When _impliedBy=stream:dev:*:project1_, this endpoint returns an empty list.  When _impliedBy=stream:dev:write:project1_, this endpoint returns:      stream:dev:read,write:project1     stream:dev:read,write,exec:project1  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    getUserPerms(requestParameters: GetUserPermsRequest, initOverrides?: RequestInit): Promise<RespNameArray>;
+    /**
+     * Get the roles assigned to a user in the specified tenant, including those assigned transively.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    getUserRolesRaw(requestParameters: GetUserRolesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespNameArray>>;
+    /**
+     * Get the roles assigned to a user in the specified tenant, including those assigned transively.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    getUserRoles(requestParameters: GetUserRolesRequest, initOverrides?: RequestInit): Promise<RespNameArray>;
+    /**
+     * Get all users in a tenant assigned a permission.  The permSpec parameter is a permission specification that uses colons as separators, the asterisk as a wildcard character and commas to define lists.  Here are examples of permission specifications:      system:mytenant:read:mysystem     system:mytenant:*:mysystem     system:mytenant     files:mytenant:read,write:mysystems This method recognizes the percent sign (%) as a string wildcard only in the context of database searching.  If a percent sign (%) appears in the permSpec it is interpreted as a zero or more character wildcard.  For example, the following specification would match the first three of the above example specifications but not the fourth:      system:mytenant:%  The wildcard character cannot appear as the first character in the permSpec.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    getUsersWithPermissionRaw(requestParameters: GetUsersWithPermissionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespNameArray>>;
+    /**
+     * Get all users in a tenant assigned a permission.  The permSpec parameter is a permission specification that uses colons as separators, the asterisk as a wildcard character and commas to define lists.  Here are examples of permission specifications:      system:mytenant:read:mysystem     system:mytenant:*:mysystem     system:mytenant     files:mytenant:read,write:mysystems This method recognizes the percent sign (%) as a string wildcard only in the context of database searching.  If a percent sign (%) appears in the permSpec it is interpreted as a zero or more character wildcard.  For example, the following specification would match the first three of the above example specifications but not the fourth:      system:mytenant:%  The wildcard character cannot appear as the first character in the permSpec.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    getUsersWithPermission(requestParameters: GetUsersWithPermissionRequest, initOverrides?: RequestInit): Promise<RespNameArray>;
+    /**
+     * Get all users assigned a role.  The role must exist in the tenant.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    getUsersWithRoleRaw(requestParameters: GetUsersWithRoleRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespNameArray>>;
+    /**
+     * Get all users assigned a role.  The role must exist in the tenant.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    getUsersWithRole(requestParameters: GetUsersWithRoleRequest, initOverrides?: RequestInit): Promise<RespNameArray>;
+    /**
+     * Grant a user the tenant administrator role.  A valid tenant and user must be specified in the request body.  The user specified in the JWT must be an administrator in the tenant specified in the request body.
+     */
+    grantAdminRoleRaw(requestParameters: GrantAdminRoleRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
+    /**
+     * Grant a user the tenant administrator role.  A valid tenant and user must be specified in the request body.  The user specified in the JWT must be an administrator in the tenant specified in the request body.
+     */
+    grantAdminRole(requestParameters: GrantAdminRoleRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
+    /**
+     * Grant a user the specified role.  A valid tenant and user must be specified in the request body.  This request is authorized only if the requestor is the role owner or an administrator.  The user and the role must be in the same tenant.
+     */
+    grantRoleRaw(requestParameters: GrantRoleRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
+    /**
+     * Grant a user the specified role.  A valid tenant and user must be specified in the request body.  This request is authorized only if the requestor is the role owner or an administrator.  The user and the role must be in the same tenant.
+     */
+    grantRole(requestParameters: GrantRoleRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
+    /**
+     * Grant a user the specified role containing the specified permission.  This compound request first adds the permission to the role if it is not already a member of the role and then assigns the role to the user.  The change count returned can range from zero to two depending on how many insertions were actually required.  Only the role owner or an administrator is authorized to make this request.  The user and the role must be in the same tenant.
+     */
+    grantRoleWithPermissionRaw(requestParameters: GrantRoleWithPermissionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
+    /**
+     * Grant a user the specified role containing the specified permission.  This compound request first adds the permission to the role if it is not already a member of the role and then assigns the role to the user.  The change count returned can range from zero to two depending on how many insertions were actually required.  Only the role owner or an administrator is authorized to make this request.  The user and the role must be in the same tenant.
+     */
+    grantRoleWithPermission(requestParameters: GrantRoleWithPermissionRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
+    /**
+     * Grant a user the specified permission by assigning that permission to to the user\'s default role.  If the user\'s default role does not exist,this request will create that role and grant it to the user before assigning the permission to the role.  A user\'s default role name is discoverable by calling either of the user/defaultRole or role/defaultRole endpoints.  The change count returned can range from zero to three depending on how many insertions and updates were actually required  The caller must be an administrator or service allowed to perform updates in the user\'s tenant.
+     */
+    grantUserPermissionRaw(requestParameters: GrantUserPermissionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
+    /**
+     * Grant a user the specified permission by assigning that permission to to the user\'s default role.  If the user\'s default role does not exist,this request will create that role and grant it to the user before assigning the permission to the role.  A user\'s default role name is discoverable by calling either of the user/defaultRole or role/defaultRole endpoints.  The change count returned can range from zero to three depending on how many insertions and updates were actually required  The caller must be an administrator or service allowed to perform updates in the user\'s tenant.
+     */
+    grantUserPermission(requestParameters: GrantUserPermissionRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
+    /**
+     * Check whether a user in a tenant has been assigned the specified role, either directly or transitively.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    hasRoleRaw(requestParameters: HasRoleRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespAuthorized>>;
+    /**
+     * Check whether a user in a tenant has been assigned the specified role, either directly or transitively.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    hasRole(requestParameters: HasRoleRequest, initOverrides?: RequestInit): Promise<RespAuthorized>;
+    /**
+     * Check whether a user in a tenant has been assigned all of the roles specified in the request body.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    hasRoleAllRaw(requestParameters: HasRoleAllRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespAuthorized>>;
+    /**
+     * Check whether a user in a tenant has been assigned all of the roles specified in the request body.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    hasRoleAll(requestParameters: HasRoleAllRequest, initOverrides?: RequestInit): Promise<RespAuthorized>;
+    /**
+     * Check whether a user in a tenant has been assigned any of the roles specified in the request body.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    hasRoleAnyRaw(requestParameters: HasRoleAnyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespAuthorized>>;
+    /**
+     * Check whether a user in a tenant has been assigned any of the roles specified in the request body.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    hasRoleAny(requestParameters: HasRoleAnyRequest, initOverrides?: RequestInit): Promise<RespAuthorized>;
+    /**
+     * Check whether a user in a tenant has been assigned the tenant administrator role, either directly or transitively.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    isAdminRaw(requestParameters: IsAdminRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespAuthorized>>;
+    /**
+     * Check whether a user in a tenant has been assigned the tenant administrator role, either directly or transitively.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    isAdmin(requestParameters: IsAdminRequest, initOverrides?: RequestInit): Promise<RespAuthorized>;
+    /**
+     * Check whether specified permission matches a permission assigned to the user, either directly or transitively.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    isPermittedRaw(requestParameters: IsPermittedRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespAuthorized>>;
+    /**
+     * Check whether specified permission matches a permission assigned to the user, either directly or transitively.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    isPermitted(requestParameters: IsPermittedRequest, initOverrides?: RequestInit): Promise<RespAuthorized>;
+    /**
+     * Check whether a user\'s permissions satisfy all of the permission specifications contained in the request body.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    isPermittedAllRaw(requestParameters: IsPermittedAllRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespAuthorized>>;
+    /**
+     * Check whether a user\'s permissions satisfy all of the permission specifications contained in the request body.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    isPermittedAll(requestParameters: IsPermittedAllRequest, initOverrides?: RequestInit): Promise<RespAuthorized>;
+    /**
+     * Check whether a user\'s permissions satisfy any of the permission specifications contained in the request body.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    isPermittedAnyRaw(requestParameters: IsPermittedAnyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespAuthorized>>;
+    /**
+     * Check whether a user\'s permissions satisfy any of the permission specifications contained in the request body.  This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
+     */
+    isPermittedAny(requestParameters: IsPermittedAnyRequest, initOverrides?: RequestInit): Promise<RespAuthorized>;
+    /**
+     * Revoke the previously granted tenant administrator role from a user. No action is taken if the user is not currently assigned the role (the request is idempotent).  The request will not be honored if revoking the role would leave the tenant with no administrator.  The user specified in the JWT must themselves be an administrator and a valid tenant and user must be specified in the request body.
+     */
+    revokeAdminRoleRaw(requestParameters: RevokeAdminRoleRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
+    /**
+     * Revoke the previously granted tenant administrator role from a user. No action is taken if the user is not currently assigned the role (the request is idempotent).  The request will not be honored if revoking the role would leave the tenant with no administrator.  The user specified in the JWT must themselves be an administrator and a valid tenant and user must be specified in the request body.
+     */
+    revokeAdminRole(requestParameters: RevokeAdminRoleRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
+    /**
+     * Revoke the specified permission from the user\'s default role. A user\'s default role is constructed by prepending \'$$\' to the user\'s name. Default roles are created on demand. If the role does not exist when this method is called no error is reported and no changes occur.  The change count returned can be zero or one depending on how many permissions were revoked.  A valid tenant and user must be specified in the request body.  The caller must be an administrator, a service or the user themselves.
+     */
+    revokeUserPermissionRaw(requestParameters: RevokeUserPermissionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
+    /**
+     * Revoke the specified permission from the user\'s default role. A user\'s default role is constructed by prepending \'$$\' to the user\'s name. Default roles are created on demand. If the role does not exist when this method is called no error is reported and no changes occur.  The change count returned can be zero or one depending on how many permissions were revoked.  A valid tenant and user must be specified in the request body.  The caller must be an administrator, a service or the user themselves.
+     */
+    revokeUserPermission(requestParameters: RevokeUserPermissionRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
+    /**
+     * Revoke a previously granted role from a user. No action is taken if the user is not currently assigned the role. This request is idempotent.  This request is authorized only if the requestor is the role owner or an administrator.
+     */
+    revokeUserRoleRaw(requestParameters: RevokeUserRoleRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
+    /**
+     * Revoke a previously granted role from a user. No action is taken if the user is not currently assigned the role. This request is idempotent.  This request is authorized only if the requestor is the role owner or an administrator.
+     */
+    revokeUserRole(requestParameters: RevokeUserRoleRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
+}