# installation

From **GitHub v3 REST API**.

Installation

- Type: `object`

## Properties

### `access_tokens_url`

- Required: true
- Type: `string`
- Format: `uri`
- Example: `https://api.github.com/installations/1/access_tokens`

### `account`

- Required: true
- Nullable: true

### `app_id`

- Required: true
- Type: `integer`
- Example: `1`

### `app_slug`

- Required: true
- Type: `string`
- Example: `github-actions`

### `contact_email`

- Required: false
- Type: `string`
- Nullable: true
- Example: `"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"`

### `created_at`

- Required: true
- Type: `string`
- Format: `date-time`

### `events`

- Required: true
- Type: `array`

### `has_multiple_single_files`

- Required: false
- Type: `boolean`
- Example: `true`

### `html_url`

- Required: true
- Type: `string`
- Format: `uri`
- Example: `https://github.com/organizations/github/settings/installations/1`

### `id`

- Required: true
- Type: `integer`
- Example: `1`

The ID of the installation.

### `permissions`

- Required: true
- Type: `object`
- Example: `{
  "contents": "read",
  "deployments": "write",
  "issues": "read",
  "single_file": "read"
}`

The permissions granted to the user-to-server access token.

### `repositories_url`

- Required: true
- Type: `string`
- Format: `uri`
- Example: `https://api.github.com/installation/repositories`

### `repository_selection`

- Required: true
- Type: `string`
- Allowed values: `"all"`, `"selected"`

Describe whether all repositories have been selected or there's a selection involved

### `single_file_name`

- Required: true
- Type: `string`
- Nullable: true
- Example: `config.yaml`

### `single_file_paths`

- Required: false
- Type: `array`
- Example: `[
  "config.yml",
  ".github/issue_TEMPLATE.md"
]`

### `suspended_at`

- Required: true
- Type: `string`
- Format: `date-time`
- Nullable: true

### `suspended_by`

- Required: true
- Type: `object`
- Nullable: true

Simple User

### `target_id`

- Required: true
- Type: `integer`

The ID of the user or organization this token is being scoped to.

### `target_type`

- Required: true
- Type: `string`
- Example: `Organization`

### `updated_at`

- Required: true
- Type: `string`
- Format: `date-time`

## JSON Schema

```json
{"description":"Installation","properties":{"access_tokens_url":{"example":"https://api.github.com/installations/1/access_tokens","format":"uri","type":"string"},"account":{"anyOf":[{"$ref":"#/components/schemas/simple-user"},{"$ref":"#/components/schemas/enterprise"}],"nullable":true},"app_id":{"example":1,"type":"integer"},"app_slug":{"example":"github-actions","type":"string"},"contact_email":{"example":"\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"","nullable":true,"type":"string"},"created_at":{"format":"date-time","type":"string"},"events":{"items":{"type":"string"},"type":"array"},"has_multiple_single_files":{"example":true,"type":"boolean"},"html_url":{"example":"https://github.com/organizations/github/settings/installations/1","format":"uri","type":"string"},"id":{"description":"The ID of the installation.","example":1,"type":"integer"},"permissions":{"$ref":"#/components/schemas/app-permissions"},"repositories_url":{"example":"https://api.github.com/installation/repositories","format":"uri","type":"string"},"repository_selection":{"description":"Describe whether all repositories have been selected or there's a selection involved","enum":["all","selected"],"type":"string"},"single_file_name":{"example":"config.yaml","nullable":true,"type":"string"},"single_file_paths":{"example":["config.yml",".github/issue_TEMPLATE.md"],"items":{"type":"string"},"type":"array"},"suspended_at":{"format":"date-time","nullable":true,"type":"string"},"suspended_by":{"$ref":"#/components/schemas/nullable-simple-user"},"target_id":{"description":"The ID of the user or organization this token is being scoped to.","type":"integer"},"target_type":{"example":"Organization","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","app_id","app_slug","target_id","target_type","single_file_name","repository_selection","access_tokens_url","html_url","repositories_url","events","account","permissions","created_at","updated_at","suspended_by","suspended_at"],"title":"Installation","type":"object"}
```