Skip to content
forgit api docs

Add users to Codespaces access for an organization

Deprecated
POST
/orgs/{org}/codespaces/access/selected_users

Codespaces for the specified users will be billed to the organization.

To use this endpoint, the access settings for the organization must be set to selected_members. For information on how to change this setting, see “Manage access control for organization codespaces.”

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
org
required
string

The organization name. The name is not case sensitive.

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
selected_usernames
required

The usernames of the organization members and outside collaborators whose codespaces should be billed to the organization.

Array<string>
<= 100 items
Examples
Example default 
{
  "selected_usernames": [
    "johnDoe",
    "atomIO"
  ]
}

Responses

Section titled “ Responses ”

204

Section titled “ 204 ”

Response when successfully modifying permissions.

304

Section titled “ 304 ”

Not modified

400

Section titled “ 400 ”

Users are neither members nor collaborators of this organization.

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

Section titled “ 422 ”

Validation failed, or the endpoint has been spammed.

Media type application/json
Validation Error

Validation Error

object
message
required
string
documentation_url
required
string
errors
Array<object>
object
resource
string
field
string
message
string
code
required
string
index
integer
value
One of:
string
nullable
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    {
      "resource": "example",
      "field": "example",
      "message": "example",
      "code": "example",
      "index": 1,
      "value": [
        "example"
      ]
    }
  ]
}

500

Section titled “ 500 ”

Internal Error

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}