Organizations

On this page

Add new license

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/licenses \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /licenses

Body parameter

{
	"license": "string"
}

Parameters

Name	In	Type	Required	Description
`body`	body	codersdk.AddLicenseRequest	true	Add license request

Example responses

201 Response

{
	"claims": {},
	"id": 0,
	"uploaded_at": "2019-08-24T14:15:22Z",
	"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	codersdk.License

To perform this operation, you must be authenticated. Learn more.

Update license entitlements

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/licenses/refresh-entitlements \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /licenses/refresh-entitlements

Example responses

201 Response

{
	"detail": "string",
	"message": "string",
	"validations": [
		{
			"detail": "string",
			"field": "string"
		}
	]
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	codersdk.Response

To perform this operation, you must be authenticated. Learn more.

Get organizations

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /organizations

Example responses

200 Response

[
	{
		"created_at": "2019-08-24T14:15:22Z",
		"description": "string",
		"display_name": "string",
		"icon": "string",
		"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
		"is_default": true,
		"name": "string",
		"updated_at": "2019-08-24T14:15:22Z"
	}
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.Organization

Response Schema

Status Code 200

Name	Type	Required
`[array item]`	array	false
`» created_at`	string(date-time)	true
`» description`	string	false
`» display_name`	string	false
`» icon`	string	false
`» id`	string(uuid)	true
`» is_default`	boolean	true
`» name`	string	false
`» updated_at`	string(date-time)	true

To perform this operation, you must be authenticated. Learn more.

Create organization

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/organizations \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /organizations

Body parameter

{
	"description": "string",
	"display_name": "string",
	"icon": "string",
	"name": "string"
}

Parameters

Name	In	Type	Required	Description
`body`	body	codersdk.CreateOrganizationRequest	true	Create organization request

Example responses

201 Response

{
	"created_at": "2019-08-24T14:15:22Z",
	"description": "string",
	"display_name": "string",
	"icon": "string",
	"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
	"is_default": true,
	"name": "string",
	"updated_at": "2019-08-24T14:15:22Z"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	codersdk.Organization

To perform this operation, you must be authenticated. Learn more.

Get organization by ID

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization} \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /organizations/{organization}

Parameters

Name	In	Type	Required	Description
`organization`	path	string(uuid)	true	Organization ID

Example responses

200 Response

{
	"created_at": "2019-08-24T14:15:22Z",
	"description": "string",
	"display_name": "string",
	"icon": "string",
	"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
	"is_default": true,
	"name": "string",
	"updated_at": "2019-08-24T14:15:22Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Organization

To perform this operation, you must be authenticated. Learn more.

Delete organization

Code samples

# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization} \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

DELETE /organizations/{organization}

Parameters

Name	In	Type	Required	Description
`organization`	path	string	true	Organization ID or name

Example responses

200 Response

{
	"detail": "string",
	"message": "string",
	"validations": [
		{
			"detail": "string",
			"field": "string"
		}
	]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Response

To perform this operation, you must be authenticated. Learn more.

Update organization

Code samples

# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

PATCH /organizations/{organization}

Body parameter

{
	"description": "string",
	"display_name": "string",
	"icon": "string",
	"name": "string"
}

Parameters

Name	In	Type	Required	Description
`organization`	path	string	true	Organization ID or name
`body`	body	codersdk.UpdateOrganizationRequest	true	Patch organization request

Example responses

200 Response

{
	"created_at": "2019-08-24T14:15:22Z",
	"description": "string",
	"display_name": "string",
	"icon": "string",
	"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
	"is_default": true,
	"name": "string",
	"updated_at": "2019-08-24T14:15:22Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Organization

To perform this operation, you must be authenticated. Learn more.