UNPKG

@openshift-console/dynamic-plugin-sdk

Version:

Provides core APIs, types and utilities used by dynamic plugins at runtime.

25 lines (24 loc) 1.45 kB
import { AccessReviewResourceAttributes, SelfSubjectAccessReviewKind } from '../../../extensions/console-types'; import { ImpersonateKind } from '../../redux-types'; /** * Provides information about user access to a given resource. * @param resourceAttributes resource attributes for access review * @param impersonate impersonation details * @returns Object with resource access information. */ export declare const checkAccess: (resourceAttributes: AccessReviewResourceAttributes, impersonate?: ImpersonateKind) => Promise<SelfSubjectAccessReviewKind>; /** * Hook that provides information about user access to a given resource. * @param resourceAttributes resource attributes for access review * @param impersonate impersonation details * @returns Array with `isAllowed` and `loading` values. */ export declare const useAccessReview: (resourceAttributes: AccessReviewResourceAttributes, impersonate?: ImpersonateKind, noCheckForEmptyGroupAndResource?: boolean) => [boolean, boolean]; /** * @deprecated - Use useAccessReview from \@console/dynamic-plugin-sdk instead. * Hook that provides allowed status about user access to a given resource. * @param resourceAttributes resource attributes for access review * @param impersonate impersonation details * @returns The isAllowed boolean value. */ export declare const useAccessReviewAllowed: (resourceAttributes: AccessReviewResourceAttributes, impersonate?: ImpersonateKind) => boolean;