@unkey/api
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.
32 lines • 1.72 kB
TypeScript
import * as z from "zod/v3";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
import { Meta } from "./meta.js";
import { Role } from "./role.js";
export type V2KeysRemoveRolesResponseBody = {
/**
* Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
*/
meta: Meta;
/**
* Complete list of all roles directly assigned to the key after the removal operation completes.
*
* @remarks
*
* The response includes:
* - The remaining roles still assigned to the key (after removing the specified roles)
* - Both ID and name for each role for easy reference
*
* Important notes:
* - The response reflects the current state after the removal operation
* - An empty array indicates the key now has no roles assigned
* - This only shows direct role assignments
* - Role permissions are not expanded in this response - use keys.getKey for full details
* - Changes take effect immediately for new verifications but cached sessions may retain old permissions briefly
*/
data: Array<Role>;
};
/** @internal */
export declare const V2KeysRemoveRolesResponseBody$inboundSchema: z.ZodType<V2KeysRemoveRolesResponseBody, z.ZodTypeDef, unknown>;
export declare function v2KeysRemoveRolesResponseBodyFromJSON(jsonString: string): SafeParseResult<V2KeysRemoveRolesResponseBody, SDKValidationError>;
//# sourceMappingURL=v2keysremoverolesresponsebody.d.ts.map