Add an SSH public key to user's account

POST

/admin/users/{username}/keys

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

username

required

string

Username of the user

Request Body

Media type application/json

CreateKeyOption options when creating a key

object

key

required

An armored SSH key to add

string

unique items

read_only

Describe if the key has only read access or read/write

boolean

title

required

Title of the key to add

string

unique items

Example ^generated

{
  "key": "example",
  "read_only": true,
  "title": "example"
}

Responses

201

PublicKey

Media type application/json

PublicKey publickey is a user key to push code to repository

object

created_at

string format: date-time

fingerprint

string

id

integer format: int64

key

string

key_type

string

read_only

boolean

title

string

updated_at

string format: date-time

url

string

user

User represents a user

object

active

Is user active

boolean

avatar_url

URL to the user’s avatar

string

created

string format: date-time

description

The user’s description

string

email

string format: email

followers_count

User counts

integer format: int64

following_count

integer format: int64

full_name

The user’s full name

string

html_url

URL to the user’s profile page

string

id

The user’s id

integer format: int64

is_admin

Is the user an administrator

boolean

language

User locale

string

last_login

string format: date-time

location

The user’s location

string

login

The user’s username

string

login_name

The user’s authentication sign-in name.

string

default: empty

prohibit_login

Is user login prohibited

boolean

pronouns

The user’s pronouns

string

restricted

Is user restricted

boolean

source_id

The ID of the user’s Authentication Source

integer format: int64

starred_repos_count

integer format: int64

visibility

User visibility level option: public, limited, private

string

website

The user’s website

string

verified

boolean

Example

{
  "user": {
    "login_name": "empty"
  }
}

403

APIForbiddenError is a forbidden error response

Media type application/json

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}

422

APIValidationError is error format response related to input validation

Media type application/json

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}