---
title: profile
description: 現在の認証主体のプロフィールを確認し、本人の情報を変更する。
canonical_url: https://orchestor.io/docs/cli/profile
markdown_url: https://orchestor.io/docs/cli/profile.md
contentType: reference
---

# profile

`orc profile` は、現在の認証情報に結び付いたプロフィールを取得し、人のアカウントの名前、ユーザー名、画像URL、言語設定を更新するコマンドです。取得は本人または使用中の機械認証の情報を返し、別の利用者のIDを指定する操作はありません。

実行には認証が必要です。認証を設定する場合は [`orc auth login`](https://orchestor.io/docs/cli/auth.md) を使用してください。APIキーでも取得できますが、更新には人のアカウントが必要です。`profile` コマンドが扱う本人の情報と、[`--profile`](https://orchestor.io/docs/cli/global-flags.md) で選ぶCLIの認証設定は別のものです。

## 使い方

```bash title="terminal"
orc profile get
```

*現在の認証主体のプロフィールを取得します。*

## 更新する項目

| 項目 | 入力と動作 |
| --- | --- |
| `name` | 1〜255文字の名前。前後の空白を除き、`firstName` に保存して `lastName` を空文字にします。`firstName` や `lastName` と併用できません。 |
| `firstName` / `lastName` | 名前を個別に指定する文字列。前後の空白を除いて保存します。 |
| `username` | 2〜32文字。英字、数字、`_`、`-` を使用できます。利用者全体で一意で、`null` で解除できます。 |
| `profilePictureUrl` | 画像URLの文字列、または解除する `null`。 |
| `locale` | `ja`、`en`、または保存した設定を解除する `null`。 |

`id`、`email`、`createdAt`、権限、Workspaceや組織の所属はこの操作では変更できません。パスワードの変更にも対応していません。組織の設定は [`orc organization`](https://orchestor.io/docs/cli/organization.md) を参照してください。

## サブコマンド

### `get`

`GET /v1/users/me` の情報を返します。人のアカウントでは `id`、`email`、保存された `firstName`、`lastName`、`username`、`profilePictureUrl`、`locale`、`createdAt` と、現在のWorkspaceや有効な権限の情報を取得できます。APIキーでは `principalType` が `api_key` になり、`apiKeyId` と `apiKeyName` を返します。キーの秘密値は返しません。機械認証の `email` は配送先ではなく合成識別子で、`locale` と `createdAt` は省略されます。

```bash title="terminal"
orc profile get [options]
```

#### 使用例

```bash title="terminal"
orc profile get --json
```

*プロフィールをJSONで取得します。*

### `update`

`PATCH /v1/users/me` に更新内容を送信します。`--stdin` でJSONを読み込めます。少なくとも1つの更新項目を指定し、省略した項目は保持します。更新後は `id`、`email`、`firstName`、`lastName`、`profilePictureUrl`、`username`、`locale` を返します。取得結果にあるすべてのフィールドが更新結果にも含まれるわけではありません。

```bash title="terminal"
orc profile update [options]
```

#### 固有のオプション

##### `--first-name`

Body field: firstName

型: `string`。任意。

```bash title="terminal"
orc profile update --first-name <value>
```

##### `--last-name`

Body field: lastName

型: `string`。任意。

```bash title="terminal"
orc profile update --last-name <value>
```

##### `--locale`

Body field: locale; enum: ja|en; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc profile update --locale <value>
```

##### `--name`

Body field: name; max 255 chars

型: `string`。任意。

```bash title="terminal"
orc profile update --name <value>
```

##### `--profile-picture-url`

Profile image URL saved locally; not synchronized to WorkOS.; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc profile update --profile-picture-url <value>
```

##### `--username`

Body field: username; (use "null" or "reset" to clear); max 32 chars

型: `string`。任意。

```bash title="terminal"
orc profile update --username <value>
```

#### 使用例

```bash title="terminal"
orc profile update --stdin < profile.json
```

*ファイルの内容で本人のプロフィールを更新します。*

## 使用例

### 名前と言語設定を変更する

このJSONを保存し、`orc profile update --stdin < profile.json` で送信します。変更した内容は `orc profile get` で確認できます。

```json title="profile.json"
{
  "firstName": "Example",
  "lastName": "User",
  "locale": "ja"
}
```

*名前と言語設定を変更する*

### 任意の設定を解除する

`null` はユーザー名、画像URL、保存された言語設定を解除します。項目の省略とは異なります。

```json title="profile.json"
{
  "username": null,
  "profilePictureUrl": null,
  "locale": null
}
```

*任意の設定を解除する*

## トラブルシューティング

### 認証できない

[`orc auth status`](https://orchestor.io/docs/cli/status.md) で現在の認証状態を確認し、必要に応じて [`orc auth login`](https://orchestor.io/docs/cli/auth.md) で認証してください。更新時に `A human account is required to update a profile` が返る場合は、人のアカウントで認証します。APIキーの表示名をこの操作で変更することはできません。

### 更新内容が受け付けられない

空のJSONではなく、表にある項目を少なくとも1つ指定してください。`name` と `firstName` / `lastName` の併用を避け、ユーザー名の長さと文字種、`locale` の値を確認します。`This username is already taken` が返る場合は、別のユーザー名を指定してください。

## グローバルオプション

`orc profile` では、次の[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)を使用できます。

- [`--help`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%98%E3%83%AB%E3%83%97)
- [`--workspace`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AF%E3%83%BC%E3%82%AF%E3%82%B9%E3%83%9A%E3%83%BC%E3%82%B9)
- [`--json`](https://orchestor.io/docs/cli/global-flags.md#json-%E5%87%BA%E5%8A%9B)
- [`--pretty`](https://orchestor.io/docs/cli/global-flags.md#json-%E5%87%BA%E5%8A%9B)
- [`--format`](https://orchestor.io/docs/cli/global-flags.md#%E5%87%BA%E5%8A%9B%E5%BD%A2%E5%BC%8F)
- [`--field`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E6%8A%BD%E5%87%BA)
- [`--fields`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E6%8A%BD%E5%87%BA)
- [`--raw`](https://orchestor.io/docs/cli/global-flags.md#%E5%80%A4%E3%81%A0%E3%81%91%E3%82%92%E5%87%BA%E5%8A%9B)
- [`--output`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%B8%E3%81%AE%E5%87%BA%E5%8A%9B)
- [`--no-pager`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%9A%E3%83%BC%E3%82%B8%E9%80%81%E3%82%8A)
- [`--dry-run`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%81%AE%E4%BA%8B%E5%89%8D%E7%A2%BA%E8%AA%8D)
- [`--yes`](https://orchestor.io/docs/cli/global-flags.md#%E7%A2%BA%E8%AA%8D%E3%81%AE%E7%9C%81%E7%95%A5)
- [`--stdin`](https://orchestor.io/docs/cli/global-flags.md#%E6%A8%99%E6%BA%96%E5%85%A5%E5%8A%9B)
- [`--from-stdin`](https://orchestor.io/docs/cli/global-flags.md#%E6%A8%99%E6%BA%96%E5%85%A5%E5%8A%9B)
- [`--page-all`](https://orchestor.io/docs/cli/global-flags.md#%E3%81%99%E3%81%B9%E3%81%A6%E3%81%AE%E3%83%9A%E3%83%BC%E3%82%B8%E3%82%92%E5%8F%96%E5%BE%97)
- [`--timing`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E6%99%82%E9%96%93)

各オプションの詳細と使用例は、[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)を参照してください。

## 関連項目

- [`orc whoami`](https://orchestor.io/docs/cli/whoami.md): 認証主体と選択中のWorkspaceをまとめて確認します。
- [`orc auth status`](https://orchestor.io/docs/cli/status.md): 認証情報の状態を確認します。
- [`orc auth login`](https://orchestor.io/docs/cli/auth.md): CLIの認証を設定します。
- [グローバルオプション](https://orchestor.io/docs/cli/global-flags.md): 出力形式や認証設定の選択を確認します。

---

[Documentation index](https://orchestor.io/docs/llms.txt)