mirror of
https://github.com/Unleash/unleash.git
synced 2025-01-31 00:16:47 +01:00
95f4f641b5
https://linear.app/unleash/issue/2-1136/custom-root-roles-documentation - [Adds documentation referencing custom root roles](https://unleash-docs-git-docs-custom-root-roles-unleash-team.vercel.app/reference/rbac); - [Adds a "How to create and assign custom root roles" how-to guide](https://unleash-docs-git-docs-custom-root-roles-unleash-team.vercel.app/how-to/how-to-create-and-assign-custom-root-roles); - Standardizes "global" roles to "root" roles; - Standardizes "standard" roles to "predefined" roles to better reflect their behavior and what is shown in our UI; - Updates predefined role descriptions and makes them consistent; - Updates the side panel description of the user form; - Includes some boy scouting with some tiny fixes of things identified along the way (e.g. the role form was persisting old data when closed and re-opened); Questions: - Is it worth expanding the "Assigning custom root roles" section in the "How to create and assign custom root roles" guide to include the steps for assigning a root role for each entity (user, service account, group)? - Should this PR include an update to the existing "How to create and assign custom project roles" guide? We've since updated the UI; --------- Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
35 lines
1.1 KiB
TypeScript
35 lines
1.1 KiB
TypeScript
import { FromSchema } from 'json-schema-to-ts';
|
|
import { userSchema } from './user-schema';
|
|
|
|
export const createUserResponseSchema = {
|
|
$id: '#/components/schemas/createUserResponseSchema',
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
description: 'An Unleash user after creation',
|
|
required: ['id'],
|
|
properties: {
|
|
...userSchema.properties,
|
|
rootRole: {
|
|
description:
|
|
'Which [root role](https://docs.getunleash.io/reference/rbac#predefined-roles) this user is assigned. Usually a numeric role ID, but can be a string when returning newly created user with an explicit string role.',
|
|
oneOf: [
|
|
{
|
|
type: 'integer',
|
|
example: 1,
|
|
minimum: 0,
|
|
},
|
|
{
|
|
type: 'string',
|
|
example: 'Admin',
|
|
enum: ['Admin', 'Editor', 'Viewer', 'Owner', 'Member'],
|
|
},
|
|
],
|
|
},
|
|
},
|
|
components: {},
|
|
} as const;
|
|
|
|
export type CreateUserResponseSchema = FromSchema<
|
|
typeof createUserResponseSchema
|
|
>;
|