@akamai/openapi-ts
    Preparing search index...

    Type Alias PostClientData

    type PostClientData = {
        body?: {
            id?: string;
            label: string;
            public?: boolean;
            redirect_uri: string;
            secret?: string;
            status?: "active" | "disabled" | "suspended";
            thumbnail_url?: string | null;
        };
        path?: never;
        query?: never;
        url: "account/oauth-clients";
    }
    Index

    Properties

    body? path? query? url

    Properties

    Optionalbody

    body?: {
        id?: string;
        label: string;
        public?: boolean;
        redirect_uri: string;
        secret?: string;
        status?: "active" | "disabled" | "suspended";
        thumbnail_url?: string | null;
    }

    A third-party application registered to Linode that users may log into with their Linode account through our authentication server at login.linode.com. Using an OAuth Client, a third-party developer may be given access to some, or all, of a User's account for the purposes of their application.

    Type Declaration

    • Optional Readonlyid?: string

      Read-only The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret).

    • label: string

      Filterable The name of this application. This will be presented to users when they are asked to grant it access to their Account.

    • Optionalpublic?: boolean

      Filterable If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the OAuth spec for more details.

    • redirect_uri: string

      The location a successful log in from login.linode.com should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange.

    • Optional Readonlysecret?: string

      Read-only The OAuth Client secret, used in the OAuth exchange. This is returned as <REDACTED> except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.

    • Optionalstatus?: "active" | "disabled" | "suspended"

      Read-only The status of this application. active by default.

    • Optional Readonlythumbnail_url?: string | null

      Read-only The URL where this client's thumbnail may be viewed, or null if this client does not have a thumbnail set.

    path?: never
    query?: never
    url: "account/oauth-clients"

    Settings

    Member Visibility

    On This Page

    Properties