Class DeviceLogin

authorize

• authorize(
      parameters: {
          apiKeyName: string;
          onCode: (authorization: DeviceAuthorization) => void | Promise<void>;
          signal?: AbortSignal;
          timeout?: number;
      },
  ): Promise<ApiKeyCreated>

  Log in this device: start a login, report it through onCode, and poll at the service's interval, slowing down when asked, until the key is issued.

  A denied login throws InvalidRequestError with code "access_denied". A login that expires, or outlasts timeout milliseconds, throws GrepvineError.

  const { key } = await client.deviceLogin.authorize({
    apiKeyName: "build agent",
    onCode: ({ user_code, verification_uri_complete }) =>
      console.log(`Open ${verification_uri_complete} and enter ${user_code}`),
  });
  Copy

  Parameters

  • parameters: {
        apiKeyName: string;
        onCode: (authorization: DeviceAuthorization) => void | Promise<void>;
        signal?: AbortSignal;
        timeout?: number;
    }

  Returns Promise<ApiKeyCreated>