Function createToken

createToken<ThrowOnError extends boolean = true>(
    options: Options<CreateTokenData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: {
                createdAt: string;
                ipAddress: string;
                lastAccessedAt: string;
                lastTokenChars: string;
                name: string;
                roles: string[];
                token: string;
                updatedAt: string;
                userAgent: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                org: { data: { id: string; type: string }; links: { self: string } };
                user: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
Create Token Logs in to an organization with domain, email, and password.

NOTE

Machine tokens can be created within the settings section by an administrator for API, tracking, and hook access
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<CreateTokenData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: {
                createdAt: string;
                ipAddress: string;
                lastAccessedAt: string;
                lastTokenChars: string;
                name: string;
                roles: string[];
                token: string;
                updatedAt: string;
                userAgent: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                org: { data: { id: string; type: string }; links: { self: string } };
                user: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
- Defined in src/api/sdk.gen.ts:5202

Function createToken

NOTE

Type Parameters

Parameters

Settings

On This Page