Class UserSshKeyResource

Index

Constructors

constructor

Methods

create list

Constructors

constructor

new UserSshKeyResource(http: HttpClient): UserSshKeyResource
Parameters
- http: HttpClient
Returns UserSshKeyResource
- Defined in packages/sdk/src/v1/resources/users.ts:34

Methods

create

create(
user: string,
input: { label: string; public_key: string },
): Promise<UserSSHKey>
Register an SSH public key Registers one comment-free Ed25519 public key for Git-over-SSH. The key is encrypted before storage; responses expose only its label, algorithm and OpenSSH SHA-256 fingerprint. The caller must be the user named by user and must present a first-party session or a full_access personal access token.
Parameters
- user: string
  User ID (usr_...) or me.
- input: { label: string; public_key: string }
  Request body.
  - label: string
    A label such as Work laptop.
  - public_key: string
    One ssh-ed25519 <base64> public key without options or a comment.
Returns Promise<UserSSHKey>
Metadata for the registered key; no key material.
- Defined in packages/sdk/src/v1/resources/users.ts:70

list

list(
    user: string,
    params?: { afterCursor?: string; limit?: number },
): Promise<
    {
        after_cursor?: string
        | null;
        before_cursor?: string | null;
        data: {
            algorithm: string;
            created_at: string;
            fingerprint: string;
            id: string;
            label: string;
            revoked_at?: string | null;
        }[];
        has_more: boolean;
    },
>
List registered SSH keys Returns a cursor-paginated page of SSH-key metadata for the authenticated user.
Parameters
- user: string
  User ID (usr_...) or me.
- Optionalparams: { afterCursor?: string; limit?: number }
  Query parameters.
  - OptionalafterCursor?: string
    Opaque cursor for the next page of older keys.
  - Optionallimit?: number
    Maximum keys per page. Defaults to 50; maximum is 100.
Returns Promise<
    {
        after_cursor?: string
        | null;
        before_cursor?: string | null;
        data: {
            algorithm: string;
            created_at: string;
            fingerprint: string;
            id: string;
            label: string;
            revoked_at?: string | null;
        }[];
        has_more: boolean;
    },
>
Successful response
- Defined in packages/sdk/src/v1/resources/users.ts:45

Class UserSshKeyResource

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns UserSshKeyResource

Methods

create

Parameters

label: string

public_key: string

Returns Promise<UserSSHKey>

list

Parameters

`Optional`afterCursor?: string

`Optional`limit?: number

Settings

On This Page

Class UserSshKeyResource

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns UserSshKeyResource

Methods

create

Parameters

label: string

public_key: string

Returns Promise<UserSSHKey>

list

Parameters

OptionalafterCursor?: string

Optionallimit?: number

Returns Promise< { after_cursor?: string | null; before_cursor?: string | null; data: { algorithm: string; created_at: string; fingerprint: string; id: string; label: string; revoked_at?: string | null; }[]; has_more: boolean; },>

Settings

On This Page

`Optional`afterCursor?: string

`Optional`limit?: number

Returns Promise<
{
after_cursor?: string
| null;
before_cursor?: string | null;
data: {
algorithm: string;
created_at: string;
fingerprint: string;
id: string;
label: string;
revoked_at?: string | null;
}[];
has_more: boolean;
},
>