# Documentation for `scw partner`


:::note{title="The CLI documentation pages are currently under construction"}
The content is up to date. We're making improvements to the site over the next few weeks for a better experience.
:::

<!-- DO NOT EDIT: this file is automatically generated using scw-doc-gen -->
Scaleway Partner API ( for partner only ).

- [Organization management commands](#organization-management-commands)
  - [Create a new organization](#create-a-new-organization)
  - [Get an organization](#get-an-organization)
  - [List Organizations](#list-organizations)
  - [Lock an organization](#lock-an-organization)
  - [Unlock an organization](#unlock-an-organization)
  - [Update an organization](#update-an-organization)


## Organization management commands

Organization management commands.


### Create a new organization

Create a new organization.

**Usage:**

```shell
scw partner organization create [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| partner-id | Required | Your personal `partner_id`. This is the same as your Organization ID. |
| email | Required | The email of the new organization owner |
| organization-name | Required | The name of the organization you want to create. Usually the company name |
| owner-firstname | Required | The first name of the new organization owner |
| owner-lastname | Required | The last name of the new organization owner |
| phone-number |  | The phone number of the new organization owner |
| customer-id | Required | A custom ID for the customer in your own infrastructure |
| siren-number |  | A SIREN number for the customer |



### Get an organization

Get an organization.

**Usage:**

```shell
scw partner organization get [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| organization-id |  | Organization ID to use. If none is passed the default organization ID will be used |



### List Organizations

List Organizations.

**Usage:**

```shell
scw partner organization list [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| order-by | One of: `created_at_asc`, `created_at_desc` |  |
| status | One of: `unknown_status`, `opened`, `locked`, `closed` | Only list organizations with this status |
| email |  | Only list organizations created with this email |
| customer-id |  | Only list organizations attached to this Customer ID |
| locked-by | One of: `unknown_locked_by`, `partner`, `scaleway` | Only list organizations locked by a certain entity |



### Lock an organization

Lock an organization.

**Usage:**

```shell
scw partner organization lock [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| organization-id |  | Organization ID to use. If none is passed the default organization ID will be used |



### Unlock an organization

Unlock an organization.

**Usage:**

```shell
scw partner organization unlock [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| organization-id |  | Organization ID to use. If none is passed the default organization ID will be used |



### Update an organization

Update an organization.

**Usage:**

```shell
scw partner organization update [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| email |  | The new email |
| name |  | The new name |
| owner-firstname |  | The first name of the new owner |
| owner-lastname |  | The last name of the new owner |
| phone-number |  | The phone number of the new owner |
| customer-id |  | Customer ID associated with this organization |
| comment |  | A comment about the organization |
| organization-id |  | Organization ID to use. If none is passed the default organization ID will be used |