1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-10-13 11:17:26 +02:00
unleash.unleash/frontend/src/openapi/models/publicSignupTokenSchema.ts
2023-12-04 21:49:49 +02:00

32 lines
1.2 KiB
TypeScript

/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { RoleSchema } from './roleSchema';
import type { UserSchema } from './userSchema';
/**
* Used for transporting a [public invite link](https://docs.getunleash.io/reference/public-signup#public-sign-up-tokens)
*/
export interface PublicSignupTokenSchema {
/** When the token was created. */
createdAt: string;
/** The creator's email or username */
createdBy: string | null;
/** Whether the token is active. This property will always be `false` for a token that has expired. */
enabled: boolean;
/** The time when the token will expire. */
expiresAt: string;
/** The token's name. Only for displaying in the UI */
name: string;
/** Users who sign up using this token will be given this role. */
role: RoleSchema;
/** The actual value of the token. This is the part that is used by Unleash to create an invite link */
secret: string;
/** The public signup link for the token. Users who follow this link will be taken to a signup page where they can create an Unleash user. */
url: string | null;
/** Array of users that have signed up using the token. */
users?: UserSchema[] | null;
}