@unkey/api
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.
31 lines • 1.5 kB
TypeScript
import * as z from "zod/v3";
export type V2KeysRemoveRolesRequestBody = {
/**
* Specifies which key loses the roles using the database identifier returned from createKey.
*
* @remarks
* Do not confuse this with the actual API key string that users include in requests.
* Removing roles only affects direct assignments, not permissions inherited from other sources.
* Role changes take effect immediately but may take up to 30 seconds to propagate across all regions.
*/
keyId: string;
/**
* Removes direct role assignments from the key without affecting other role sources or permissions.
*
* @remarks
* Operations are idempotent - removing non-assigned roles has no effect and causes no errors.
*
* After removal, the key loses access to permissions that were only granted through these roles.
* Invalid role references cause the entire operation to fail atomically, ensuring consistent state.
*/
roles: Array<string>;
};
/** @internal */
export type V2KeysRemoveRolesRequestBody$Outbound = {
keyId: string;
roles: Array<string>;
};
/** @internal */
export declare const V2KeysRemoveRolesRequestBody$outboundSchema: z.ZodType<V2KeysRemoveRolesRequestBody$Outbound, z.ZodTypeDef, V2KeysRemoveRolesRequestBody>;
export declare function v2KeysRemoveRolesRequestBodyToJSON(v2KeysRemoveRolesRequestBody: V2KeysRemoveRolesRequestBody): string;
//# sourceMappingURL=v2keysremoverolesrequestbody.d.ts.map