SAKURA internet ID Role API

IDロールに関する機能

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 2

GET /id-roles IDロール一覧を取得する #
GET /id-roles/{id_role_id} 指定したIDロールを取得する #

Documentation

📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/addon-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/ai-engine-inference-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/ai-engine-rag-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/apigw-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/apprun-dedicated-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/apprun-shared-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/eventbus-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/iam-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/monitoring-suite-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/networking-suite-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/nosql-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/objectstorage-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/security-control-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/security-encryption-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/seg-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/simple-notification-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/simplemq-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/simplemq-sacloud-api/index.html
📖
Documentation
https://manual.sakura.ad.jp/api/cloud/portal/workflows-api/index.html
📖
Documentation
https://github.com/sacloud/phy-api-go

Specifications

Schemas & Data

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/sakura-internet:sakura-internet-id-role-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sakura-internet-id-role-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: さくらのクラウドIAM ID Role API
  version: 2.1.0
  contact:
    name: SAKURA internet Inc.
  description: さくらのクラウドIAMのAPIドキュメントです
servers:
- url: https://secure.sakura.ad.jp/cloud/api/iam/1.0
security:
- ServicePrincipalAuth: []
tags:
- name: id-role
  x-displayName: IDロール
  description: IDロールに関する機能
paths:
  /id-roles:
    get:
      operationId: listIdRoles
      tags:
      - id-role
      summary: IDロール一覧を取得する
      parameters:
      - $ref: '#/components/parameters/PaginationPage'
      - $ref: '#/components/parameters/PaginationPerPage'
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - items
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/IdRole'
                - $ref: '#/components/schemas/Pagination'
        '401':
          description: 認証情報が無効
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Http401Unauthorized'
        '403':
          description: アクセス権限がない
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Http403Forbidden'
        '429':
          description: APIリクエストのレートリミット超過
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Http429TooManyRequests'
  /id-roles/{id_role_id}:
    parameters:
    - $ref: '#/components/parameters/IdRoleID'
    get:
      operationId: readIdRole
      tags:
      - id-role
      summary: 指定したIDロールを取得する
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdRole'
        '401':
          description: 認証情報が無効
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Http401Unauthorized'
        '403':
          description: アクセス権限がない
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Http403Forbidden'
        '404':
          description: 指定したIAMロールが存在しない
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Http404NotFound'
        '429':
          description: APIリクエストのレートリミット超過
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Http429TooManyRequests'
components:
  schemas:
    Http403Forbidden:
      type: object
      required:
      - type
      - status
      - title
      - detail
      properties:
        type:
          type: string
          description: 問題を説明するドキュメントへのURI(基本的にはabout:blank)
          example: about:blank
        status:
          type: integer
          description: HTTPステータスコード
          example: 403
        title:
          type: string
          description: 問題を表す簡単な文字列
          example: permission_denied
        detail:
          type: string
          description: 問題の詳細を説明した文字列(人が読んで問題解決に繋がるような説明)
          example: このアクションを実行する権限がありません。
    Pagination:
      type: object
      required:
      - count
      - next
      - previous
      properties:
        count:
          type: integer
          description: データ総数
          example: 100
        next:
          type:
          - string
          - 'null'
          format: uri
          description: 次のページへのURL
          example: https://api.example.com/?page=3&per_page=10
        previous:
          type:
          - string
          - 'null'
          format: uri
          description: 前のページへのURL
          example: https://api.example.com/?per_page=10
    IdRole:
      type: object
      required:
      - id
      - name
      - description
      properties:
        id:
          type: string
          description: IDロールID
          readOnly: true
          example: identity-admin
        name:
          type: string
          description: IDロール名
          example: ID管理者
        description:
          type: string
          description: IDロールの説明
          example: 管理者権限のIDロール
    Http401Unauthorized:
      type: object
      required:
      - type
      - status
      - title
      - detail
      properties:
        type:
          type: string
          description: 問題を説明するドキュメントへのURI(基本的にはabout:blank)
          example: about:blank
        status:
          type: integer
          description: HTTPステータスコード
          example: 401
        title:
          type: string
          description: 問題を表す簡単な文字列
          example: authentication_failed
        detail:
          type: string
          description: 問題の詳細を説明した文字列(人が読んで問題解決に繋がるような説明)
          example: 認証情報が含まれていません。
    Http429TooManyRequests:
      type: object
      required:
      - type
      - status
      - title
      - detail
      properties:
        type:
          type: string
          description: 問題を説明するドキュメントへのURI(基本的にはabout:blank)
          example: about:blank
        status:
          type: integer
          description: HTTPステータスコード
          example: 429
        title:
          type: string
          description: 問題を表す簡単な文字列
          example: throttled
        detail:
          type: string
          description: 問題の詳細を説明した文字列(人が読んで問題解決に繋がるような説明)
          example: リクエストの処理は絞られました。 60秒後に利用可能になります。
    Http404NotFound:
      type: object
      required:
      - type
      - status
      - title
      - detail
      properties:
        type:
          type: string
          description: 問題を説明するドキュメントへのURI(基本的にはabout:blank)
          example: about:blank
        status:
          type: integer
          description: HTTPステータスコード
          example: 404
        title:
          type: string
          description: 問題を表す簡単な文字列
          example: not_found
        detail:
          type: string
          description: 問題の詳細を説明した文字列(人が読んで問題解決に繋がるような説明)
          example: 見つかりませんでした。
  parameters:
    IdRoleID:
      in: path
      name: id_role_id
      description: IDロールID
      required: true
      schema:
        type: string
    PaginationPage:
      in: query
      name: page
      schema:
        type: integer
    PaginationPerPage:
      in: query
      name: per_page
      schema:
        type: integer
  securitySchemes:
    ServicePrincipalAuth:
      description: 'サービスプリンシパル認証

        - サービスプリンシパルのアクセストークンを指定

        '
      type: http
      scheme: bearer
    ProjectApiKeyAuth:
      description: 'APIキー認証

        - ユーザー名に発行したAPIキーのアクセストークンを指定

        - パスワードに発行したAPIキーのアクセストークンシークレットを指定

        '
      type: http
      scheme: basic
x-provenance:
  method: harvested
  publisher: SAKURA internet
  source: https://manual.sakura.ad.jp/api/cloud/portal/openapis/iam-api.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)