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/stackit:stackit-roles-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Stackit Roles API
  version: '2.0'
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  description: 'Operations tagged Roles across 2 of this provider''s published API definitions: stackit-authorization-v2.json, stackit-authorization-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://authorization.api.stackit.cloud
  variables:
    region:
      default: global
tags:
- name: Roles
paths:
  /v2/{resourceType}/{resourceId}/roles:
    get:
      operationId: ListRoles
      parameters:
      - in: path
        name: resourceType
        required: true
        schema:
          type: string
      - in: path
        name: resourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RolesResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Malformed input
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden
      summary: Get roles and permissions of a resource
      x-stackit-authorization:
        disabled: true
        implicit-actions:
        - iam.role.get
      tags:
      - Roles
    post:
      description: Add new, user specified roles to a resource, and bind permissions to them. Permissions are predefined.
      operationId: AddRole
      parameters:
      - in: path
        name: resourceType
        required: true
        schema:
          type: string
      - in: path
        name: resourceId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddRolePayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddCustomRoleResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Malformed input
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden
      summary: Add a new role
      x-stackit-authorization:
        disabled: true
        implicit-actions:
        - iam.role.add
      tags:
      - Roles
    servers:
    - url: https://authorization.api.stackit.cloud
      variables:
        region:
          default: global
  /v2/{resourceType}/{resourceId}/roles/{roleId}:
    delete:
      description: Delete a custom role by ID.
      operationId: DeleteRole
      parameters:
      - in: path
        name: resourceType
        required: true
        schema:
          type: string
      - in: path
        name: resourceId
        required: true
        schema:
          type: string
      - in: path
        name: roleId
        required: true
        schema:
          type: string
      - in: query
        name: etag
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteRoleResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Malformed input
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden
      summary: Delete an existing role
      x-stackit-authorization:
        disabled: true
        implicit-actions:
        - iam.role.remove
      tags:
      - Roles
    get:
      description: Get a custom role by ID.
      operationId: GetRole
      parameters:
      - in: path
        name: resourceType
        required: true
        schema:
          type: string
      - in: path
        name: resourceId
        required: true
        schema:
          type: string
      - in: path
        name: roleId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRoleResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Malformed input
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden
      summary: Get an existing role
      x-stackit-authorization:
        disabled: true
        implicit-actions:
        - iam.role.get
      tags:
      - Roles
    put:
      description: Update a custom role by ID.
      operationId: UpdateRole
      parameters:
      - in: path
        name: resourceType
        required: true
        schema:
          type: string
      - in: path
        name: resourceId
        required: true
        schema:
          type: string
      - in: path
        name: roleId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRolePayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRoleResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Malformed input
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden
      summary: Update an existing role
      x-stackit-authorization:
        disabled: true
        implicit-actions:
        - iam.role.edit
      tags:
      - Roles
    servers:
    - url: https://authorization.api.stackit.cloud
      variables:
        region:
          default: global
components:
  schemas:
    Permission:
      properties:
        description:
          example: Can create projects in an organization
          maxLength: 255
          minLength: 1
          title: A human readable description of the permission
          type: string
        name:
          example: iam.member.read
          maxLength: 255
          pattern: ^[a-z](?:[-.]?[a-z]){1,63}$
          title: Permission name
          type: string
      required:
      - name
      - description
      type: object
    ErrorResponse:
      example:
        error: Bad Request
        message: Some information about what caused the Error
        path: /v1/path/which/returned/error
        status: 400
        timeStamp: '2019-08-24T14:15:22Z'
      properties:
        error:
          type: string
        message:
          type: string
        path:
          type: string
        status:
          type: integer
        timeStamp:
          format: date-time
          type: string
      required:
      - timeStamp
      - path
      - status
      - error
      - message
      type: object
    RolesResponse:
      properties:
        resourceId:
          example: schwarz-it-kg-WJACUK1
          pattern: ^([a-zA-Z0-9/_|\-=+@.]{1,})$
          title: The ID of the resource, where the members should be updated
          type: string
        resourceType:
          example: organization
          pattern: ^[a-z](?:-?[a-z]){1,63}$
          title: Resource type
          type: string
        roles:
          items:
            $ref: '#/components/schemas/Role'
          title: Roles
          type: array
      required:
      - resourceId
      - resourceType
      - roles
      type: object
    UpdateRoleResponse:
      properties:
        resourceId:
          example: schwarz-it-kg-WJACUK1
          pattern: ^([a-zA-Z0-9/_|\-=+@.]{1,})$
          title: The ID of the resource in which the role was updated.
          type: string
        resourceType:
          example: organization
          pattern: ^[a-z](?:-?[a-z]){1,63}$
          title: Resource type of the resource in which the role was updated.
          type: string
        role:
          $ref: '#/components/schemas/Role'
      required:
      - resourceId
      - resourceType
      - role
      type: object
    GetRoleResponse:
      properties:
        resourceId:
          example: schwarz-it-kg-WJACUK1
          pattern: ^([a-zA-Z0-9/_|\-=+@.]{1,})$
          title: The ID of the resource from which the role was fetched.
          type: string
        resourceType:
          example: organization
          pattern: ^[a-z](?:-?[a-z]){1,63}$
          title: Resource type of the resource from which the role was fetched.
          type: string
        role:
          $ref: '#/components/schemas/Role'
      required:
      - resourceId
      - resourceType
      - role
      type: object
    PermissionRequest:
      properties:
        name:
          example: iam.member.read
          maxLength: 255
          pattern: ^[a-z](?:[-.]?[a-z]){1,63}$
          title: Existing permission
          type: string
      required:
      - name
      type: object
    UpdateRolePayload:
      properties:
        description:
          example: Role for the development team.
          maxLength: 255
          minLength: 1
          title: A human readable description of the role
          type: string
        etag:
          type: string
        name:
          example: dev-team
          pattern: ^[a-z](?:[-.]?[a-z]){1,63}$
          title: Name and of the role.
          type: string
        permissions:
          items:
            $ref: '#/components/schemas/PermissionRequest'
          title: Permissions for the role.
          type: array
      required:
      - name
      - description
      - permissions
      type: object
    AddCustomRoleResponse:
      properties:
        resourceId:
          example: schwarz-it-kg-WJACUK1
          pattern: ^([a-zA-Z0-9/_|\-=+@.]{1,})$
          title: ID of the resource to which the new role has been added.
          type: string
        resourceType:
          example: organization
          pattern: ^[a-z](?:-?[a-z]){1,63}$
          title: Resource type of the resource to which the new role has been added.
          type: string
        role:
          $ref: '#/components/schemas/Role'
      required:
      - resourceId
      - resourceType
      - role
      type: object
    DeleteRoleResponse:
      properties:
        writtenAt:
          $ref: '#/components/schemas/Zookie'
      required:
      - writtenAt
      type: object
    Role:
      properties:
        description:
          example: An owner of the project
          maxLength: 255
          title: A human readable description of the role
          type: string
        etag:
          type: string
        id:
          example: 029527b4-a8c0-4f0b-8a70-516a24cd23001
          pattern: ^([a-zA-Z0-9/_|\-=+]{1,})$
          title: The ID of the role.
          type: string
        name:
          example: my-owner
          pattern: ^[a-z](?:[-.]?[a-z]){1,63}$
          title: Name and identifier of the role.
          type: string
        permissions:
          items:
            $ref: '#/components/schemas/Permission'
          title: Permissions for the role
          type: array
      required:
      - name
      - description
      - permissions
      type: object
    Zookie:
      properties:
        zookie:
          type: string
      type: object
    AddRolePayload:
      properties:
        description:
          example: Role for the development team.
          maxLength: 255
          minLength: 1
          title: A human readable description of the role
          type: string
        name:
          example: dev-team
          pattern: ^[a-z](?:[-.]?[a-z]){1,63}$
          title: Name of the role.
          type: string
        permissions:
          items:
            $ref: '#/components/schemas/PermissionRequest'
          title: Permissions for the role.
          type: array
      required:
      - name
      - description
      - permissions
      type: object
x-refined-from:
- stackit-authorization-v2.json
- stackit-authorization-openapi.yml