Skip to content

Commit b7ec5ca

Browse files
yamitzkyclaude
andcommitted
docs: add usage examples for user invite and deactivate
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 6a293b8 commit b7ec5ca

2 files changed

Lines changed: 48 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,30 @@ sladm token status
8080
sladm teams list
8181
```
8282

83+
## Usage Examples
84+
85+
### Invite a user
86+
87+
```bash
88+
# Invite as a full member
89+
sladm users invite --team-id T024XCDSF --email new-member@example.com \
90+
--channel-ids C01ABCD2EFG
91+
92+
# Invite as a single-channel guest
93+
sladm users invite --team-id T024XCDSF --email guest@partner.com \
94+
--channel-ids C01ABCD2EFG --is-ultra-restricted true
95+
```
96+
97+
### Deactivate a user
98+
99+
```bash
100+
# Find the user
101+
sladm scim-users list --filter 'email eq "leaving@example.com"'
102+
103+
# Deactivate their account (org-wide, via SCIM API)
104+
sladm scim-users deactivate --id U02T7QBTFGA
105+
```
106+
83107
## Authentication
84108

85109
### Profile Management

README_ja.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,30 @@ sladm token status
8080
sladm teams list
8181
```
8282

83+
## Usage Examples
84+
85+
### ユーザーの招待
86+
87+
```bash
88+
# フルメンバーとして招待
89+
sladm users invite --team-id T024XCDSF --email new-member@example.com \
90+
--channel-ids C01ABCD2EFG
91+
92+
# シングルチャンネルゲストとして招待
93+
sladm users invite --team-id T024XCDSF --email guest@partner.com \
94+
--channel-ids C01ABCD2EFG --is-ultra-restricted true
95+
```
96+
97+
### ユーザーの無効化
98+
99+
```bash
100+
# ユーザーを検索
101+
sladm scim-users list --filter 'email eq "leaving@example.com"'
102+
103+
# アカウントを無効化(SCIM API で組織全体に適用)
104+
sladm scim-users deactivate --id U02T7QBTFGA
105+
```
106+
83107
## Authentication
84108

85109
### プロファイル管理

0 commit comments

Comments
 (0)