---
title: "List Roles (Internal)"
url: "https://nov18-dev.movespot.fyi/apis/konnect-identity-management-internal-2/versions/770972f0-aec8-404b-85ec-1d58e7079be2/operations/get-system-accounts-assigned-roles-internal"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-identity-management-internal-2/versions/770972f0-aec8-404b-85ec-1d58e7079be2.md

# List Roles (Internal)

`GET` `/internal/system-accounts/{accountId}/assigned-roles`

Operation ID: `get-system-accounts-assigned-roles-internal`

Fetch assigned roles for a managed system account. Returns 400 if any filter parameters are invalid.

## Path parameters

- `accountId` (string, required) - ID of the system account.

## Query parameters

- `filter` (object, optional) - Filter roles returned in the response.

## Responses

- `200` - A paginated list response for a collection of parameterized assigned roles.
- `400` - Bad Request
- `401` - Unauthenticated
- `403` - Unauthorized
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.2
info:
  title: Konnect Identity Management
  version: 2.0.0
servers:
  - url: https://global.api.konghq.com/v2
    description: Global Base URL
paths:
  /internal/system-accounts/{accountId}/assigned-roles:
    parameters:
      - name: accountId
        in: path
        description: ID of the system account.
        required: true
        schema:
          type: string
    get:
      operationId: get-system-accounts-assigned-roles-internal
      summary: List Roles (Internal)
      description: Fetch assigned roles for a managed system account. Returns 400 if
        any filter parameters are invalid.
      parameters:
        - name: filter
          in: query
          description: Filter roles returned in the response.
          required: false
          schema:
            type: object
            properties:
              role_name:
                $ref: "#/components/schemas/StringFieldEqualsFilter"
              entity_type_name:
                $ref: "#/components/schemas/StringFieldEqualsFilter"
          style: deepObject
      responses:
        "200":
          $ref: "#/components/responses/ParameterizedAssignedRolesCollection"
        "400":
          $ref: "#/components/responses/IdentityBadRequest"
        "401":
          $ref: "#/components/responses/IdentityUnauthenticated"
        "403":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/IdentityNotFound"
      security:
        - clientToken: []
      tags:
        - Managed System Accounts - Roles
security:
  - clientToken: []
components:
  schemas:
    StringFieldEqualsFilter:
      description: Filters on the given string field value by exact match.
      oneOf:
        - type: string
        - type: object
          title: StringFieldEqualsComparison
          additionalProperties: false
          properties:
            eq:
              type: string
          required:
            - eq
      title: StringFieldEqualsFilter
      x-examples:
        example-1: equals-some-value
        example-2:
          eq: some-value
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    ParameterizedAssignedRole:
      description: A parameterized assigned role is a role that has been assigned to a
        managed system account with additional parameters.
      type: object
      properties:
        id:
          description: The ID of the role assignment.
          type: string
          format: uuid
          example: eaf7adf1-32c8-4bbf-b960-d1f8456afe67
        role_name:
          description: Name of the role being assigned.
          type: string
          example: Viewer
        entity_id:
          description: A RBAC entity ID.
          type: string
          format: uuid
          example: 817d0422-45c9-4d88-8d64-45aef05c1ae7
        entity_type_name:
          description: Name of the entity type the role is being assigned to.
          type: string
          example: Runtime Groups
        entity_region:
          description: Region of the entity.
          type: string
          example: eu
          enum:
            - us
            - eu
            - au
            - me
            - in
            - sg
            - "*"
        parameters:
          description: Additional parameters for the role assignment.
          additionalProperties: true
          type: object
      example:
        id: 54cc6168-ebb1-4300-8168-d62a0dd08fc8
        role_name: Connector
        entity_id: 18ee2573-dec0-4b83-be99-fa7700bcdc61
        entity_type_name: Mesh Control Planes
        entity_region: us
        parameters:
          zoneName: zone3
      title: ParameterizedAssignedRole
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    PageMeta:
      description: Contains pagination query parameters and the total number of
        objects returned.
      type: object
      properties:
        number:
          type: number
          example: 1
        size:
          type: number
          example: 10
        total:
          type: number
          example: 100
      required:
        - number
        - size
        - total
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  responses:
    ParameterizedAssignedRolesCollection:
      description: A paginated list response for a collection of parameterized
        assigned roles.
      content:
        application/json:
          schema:
            type: object
            properties:
              meta:
                $ref: "#/components/schemas/PaginatedMeta"
              data:
                description: An Array
                type: array
                items:
                  $ref: "#/components/schemas/ParameterizedAssignedRole"
          examples:
            ParameterizedAssignedRolesCollection:
              $ref: "#/components/examples/Parameterized-Assigned-Roles-Collection-Example"
    IdentityBadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
          examples:
            Request Format is Invalid:
              $ref: "#/components/examples/400-request-format-is-invalid"
            Cannot be Blank:
              $ref: "#/components/examples/400-cannot-be-blank"
            Invalid ID format:
              $ref: "#/components/examples/400-invalid-id-format"
            Must be a valid UUID v4:
              $ref: "#/components/examples/400-valid-uuid"
            System teams cannot be modified:
              $ref: "#/components/examples/400-systems-team-modified"
            Password Complexity:
              $ref: "#/components/examples/400-password-complexity"
            Authentication Settings cannot be all Disabled:
              $ref: "#/components/examples/400-authentication-settings-cannot-be-all-disabled"
            OIDC needs an IdP configuration:
              $ref: "#/components/examples/400-oidc-auth-enabled-needs-idp"
            IdP configuration is required:
              $ref: "#/components/examples/400-idp-config-is-required"
            Unsupported filter operation:
              value:
                status: 400
                title: Bad Request
                detail: ""
                instance: konnect:trace:3674017986744198214
                invalid_parameters:
                  - field: "[filter][actions][contains]"
                    reason: "[contains] is not a supported filter operation"
    IdentityUnauthenticated:
      description: Unauthenticated
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            Unauthorized:
              $ref: "#/components/examples/401-unauthenticated"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            description: The error response object.
            type: object
            properties:
              status:
                description: The HTTP status code.
                type: integer
                example: 403
              title:
                description: The Error Response.
                type: string
                example: Unauthorized
              instance:
                description: The Konnect traceback code.
                type: string
                example: konnect:trace:952172606039454040
              detail:
                description: Details about the error response.
                type: string
                example: You do not have permission to perform this action
          examples:
            Unauthorized:
              $ref: "#/components/examples/403-permission-denied"
    IdentityNotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            Not Found:
              $ref: "#/components/examples/404-not-found"
  examples:
    Parameterized-Assigned-Roles-Collection-Example:
      value:
        meta:
          page:
            number: 1
            size: 10
            total: 100
        data:
          - id: b02e23c5-8ee4-4e5a-99f4-43329923adcd
            role_name: Connector
            entity_id: 437c7192-fea0-4f35-8478-c8d57783f8c1
            entity_type_name: Mesh Control Planes
            entity_region: us
            parameters:
              zoneName: zone2
          - id: 869d9402-f117-4f9a-840f-69acaf70a81a
            role_name: Connector
            entity_id: 18ee2573-dec0-4b83-be99-fa7700bcdc61
            entity_type_name: Mesh Control Planes
            entity_region: eu
            parameters:
              zoneName: zone3
    400-request-format-is-invalid:
      value:
        status: 400
        title: Bad Request
        detail: ""
        instance: konnect:trace:3674017986744198214
        invalid_parameters:
          - field: body
            reason: request format is invalid
    400-cannot-be-blank:
      value:
        status: 400
        title: Bad Request
        instance: konnect:trace:6644808935508571943
        detail: ""
        invalid_parameters:
          - field: name
            reason: cannot be blank
    400-invalid-id-format:
      value:
        status: 400
        title: Bad Request
        detail: ""
        instance: konnect:trace:8988732526256293040
        invalid_parameters:
          - field: teamID
            reason: invalid ID format
    400-valid-uuid:
      value:
        status: 400
        title: Bad Request
        detail: ""
        instance: konnect:trace:7680390984800447837
        invalid_parameters:
          - field: id
            reason: must be a valid UUID v4
    400-systems-team-modified:
      value:
        status: 400
        title: Bad Request
        detail: ""
        instance: konnect:trace:1738820719742148545
        invalid_parameters:
          - field: teamID
            reason: system teams cannot be modified
    400-password-complexity:
      value:
        status: 400
        title: Bad Request
        detail: Password does not meet complexity requirements.
        instance: konnect:trace:1738820719742148545
        invalid_parameters:
          - field: new_password
            reason: "is too short (minimum length: 8)"
            rule: min_length
            minimum: 8
          - field: new_password
            reason: must contain at least 1 digit
            rule: min_digits
            minimum: 1
          - field: new_password
            reason: must contain at least 1 lower case character
            rule: min_lowercase
            minimum: 1
          - field: new_password
            reason: must contain at least 1 upper case character
            rule: min_uppercase
            minimum: 1
          - field: new_password
            reason: must contain at least 1 special character
            rule: min_symbols
            minimum: 1
    400-authentication-settings-cannot-be-all-disabled:
      value:
        status: 400
        title: Bad Request
        instance: konnect:trace:6644808935508571943
        invalid_parameters:
          - field: oidc_auth_enabled
            reason: cannot be disabled when both basic auth and SAML are also disabled
          - field: basic_auth_enabled
            reason: cannot be disabled when both OIDC and SAML are also disabled
          - field: saml_auth_enabled
            reason: cannot be disabled when both OIDC and basic auth are also disabled
        detail: Atleast one of the authentication schemes from basic, oidc or saml needs
          to be enabled
    400-oidc-auth-enabled-needs-idp:
      value:
        status: 400
        title: Bad Request
        detail: ""
        instance: konnect:trace:6644808935508571943
        invalid_parameters:
          - field: oidc_auth_enabled
            reason: cannot be set before configuring an identity provider
    400-idp-config-is-required:
      value:
        status: 400
        title: Bad Request
        detail: An IdP configuration is required
        instance: konnect:trace:6644808935508571943
        invalid_parameters:
          - field: data
            reason: cannot be set before configuring an identity provider
    401-unauthenticated:
      value:
        status: 401
        title: Unauthenticated
        instance: konnect:trace:952172606039454040
        detail: A valid token is required
    403-permission-denied:
      value:
        status: 403
        title: Permission denied
        instance: konnect:trace:2822394689570210664
        detail: Only enterprise organizations can create teams
    404-not-found:
      value:
        status: 404
        title: Not Found
        instance: konnect:trace:2287285207635123011
        detail: The requested team was not found
  securitySchemes:
    clientToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The Client token is meant to be used by internal service clients for the
        MinK integration.
```
