メインコンテンツまでスキップ
API docs by Redocly

idp-server コントロールプレーン ロール・権限管理 API (1.0.0)

Download OpenAPI specification:Download

ロールおよび権限の管理API仕様書

organization-role

組織レベルロール管理

Create role within organization tenant

組織内の特定のテナントに新しいロールを作成します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

query Parameters
dry_run
boolean
Default: false

trueの場合、リクエストの検証のみで実行はされません

Request Body schema: application/json
required
name
required
string <= 255 characters

Role name (must be unique within tenant)

description
string <= 255 characters

Human-readable description of the role

permissions
required
Array of strings <uuid> [ items <uuid > ]

List of permission IDs to assign to this role (empty array is allowed)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "dry_run": true,
  • "result": {
    }
}

List roles within organization tenant

組織内の特定のテナントのロール一覧を取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 20

返すアイテムの最大数

offset
integer >= 0
Default: 0

アイテムを返す開始インデックス

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total_count": 0,
  • "limit": 0,
  • "offset": 0
}

Get role within organization tenant

組織内のテナントの特定のロールを取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

role-id
required
string <uuid>

ロールの識別子

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "permissions": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update role within organization tenant

組織内のテナントの特定のロールを更新します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

role-id
required
string <uuid>

ロールの識別子

query Parameters
dry_run
boolean
Default: false

trueの場合、リクエストの検証のみで実行はされません

Request Body schema: application/json
required
name
required
string <= 255 characters

Role name (must be unique within tenant)

description
string <= 255 characters

Human-readable description of the role

permissions
required
Array of strings <uuid> [ items <uuid > ]

List of permission IDs to assign to this role (empty array is allowed for complete removal)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "dry_run": true,
  • "result": {
    }
}

Delete role within organization tenant

組織内のテナントの特定のロールを削除します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

role-id
required
string <uuid>

ロールの識別子

query Parameters
dry_run
boolean
Default: false

trueの場合、リクエストの検証のみで実行はされません

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string",
  • "error_messages": [
    ],
  • "error_details": { }
}

organization-permission

組織レベル権限管理

Create permission within organization tenant

組織内の特定のテナントに新しい権限を作成します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

query Parameters
dry_run
boolean
Default: false

trueの場合、リクエストの検証のみで実行はされません

Request Body schema: application/json
required
name
required
string <= 255 characters

Permission name (must be unique within tenant)

description
string

Human-readable description of the permission

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "dry_run": true,
  • "result": {
    }
}

List permissions within organization tenant

組織内の特定のテナントの権限一覧を取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 20

返すアイテムの最大数

offset
integer >= 0
Default: 0

アイテムを返す開始インデックス

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total_count": 0,
  • "limit": 0,
  • "offset": 0
}

Get permission within organization tenant

組織内のテナントの特定の権限を取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

permission-id
required
string <uuid>

権限の識別子

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update permission within organization tenant

組織内のテナントの特定の権限を更新します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

permission-id
required
string <uuid>

権限の識別子

query Parameters
dry_run
boolean
Default: false

trueの場合、リクエストの検証のみで実行はされません

Request Body schema: application/json
required
name
required
string <= 255 characters

Permission name (must be unique within tenant)

description
string

Human-readable description of the permission

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "dry_run": true,
  • "result": {
    }
}

Delete permission within organization tenant

組織内のテナントの特定の権限を削除します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

permission-id
required
string <uuid>

権限の識別子

query Parameters
dry_run
boolean
Default: false

trueの場合、リクエストの検証のみで実行はされません

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string",
  • "error_messages": [
    ],
  • "error_details": { }
}