Function createRoleGroup

createRoleGroup<ThrowOnError extends boolean = true>(
    options: Options<CreateRoleGroupData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: {
                createdAt: string;
                description: string;
                display: boolean;
                name: string;
                roles: string[];
                system: boolean;
                updatedAt: string;
            };
            id: string;
            relationships: {
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
Create a Role Group Creates a custom role group for the organization.

Auth Roles
For a list of latest available outh roles, checkout the response from the Get Auth Roles API endpoint.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<CreateRoleGroupData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: {
                createdAt: string;
                description: string;
                display: boolean;
                name: string;
                roles: string[];
                system: boolean;
                updatedAt: string;
            };
            id: string;
            relationships: {
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
- Defined in src/api/sdk.gen.ts:5309

Function createRoleGroup

Auth Roles

Type Parameters

Parameters

Settings

On This Page