Tessell Roles API

openapi: 3.0.3
info:
  title: Tessell APIs activity-center Roles API
  contact:
    email: support@tessell.com
    name: Tessell Inc
    url: https://www.tessell.com
  description: Tessell API Documentation
  termsOfService: https://www.tessell.com/terms
  version: '1.0'
servers:
- url: '{server}'
  variables:
    server:
      default: console.tessell.com
tags:
- name: Roles
paths:
  /iam/roles:
    get:
      tags:
      - Roles
      summary: Get a list of Roles
      operationId: getRoles
      security:
      - BearerAuth: []
      parameters:
      - name: entity-type
        in: query
        description: entity-type
        required: false
        style: form
        schema:
          type: string
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/pageOffset'
      - $ref: '#/components/parameters/timeZone'
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleApiResponse'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    RoleApiResponse:
      title: RoleApiResponse
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/apiMetadata'
        response:
          type: array
          items:
            $ref: '#/components/schemas/RoleResponse'
    ApiError:
      type: object
      description: Common error response object for non 2xx responses
      properties:
        code:
          type: string
          description: Status code for the error response
        message:
          type: string
          description: Error message for API response
        resolution:
          type: string
        timestamp:
          type: string
          format: date-time
        contextId:
          type: string
          description: ContextId of API request
        sessionId:
          type: string
          description: SessionId of API request
        tessellErrorCode:
          type: string
          description: Unique error code specific to Tessell
    RoleResponse:
      title: RoleResponse
      type: object
      properties:
        role:
          type: string
          description: role name
        description:
          type: string
          description: Description of role
        entityType:
          type: string
          description: entity type
        permissions:
          type: array
          description: List of permissions
          items:
            $ref: '#/components/schemas/PermissionResponse'
        status:
          $ref: '#/components/schemas/RoleStatus'
        dateCreated:
          type: string
          description: Date when onboarded acl is created  metadata
          format: date-time
        dateModified:
          type: string
          description: Date when onboarded acl is last modified  metadata
          format: date-time
      description: This is a definition for Tessell internal create onboarded acl payload object
    apiPaginationInfo:
      title: apiPaginationInfo
      type: object
      properties:
        pageSize:
          type: integer
          format: int32
        pageOffset:
          type: integer
          format: int32
    apiMetadata:
      title: apiMetadata
      type: object
      properties:
        timeZone:
          type: string
        records:
          type: integer
          format: int32
        pagination:
          $ref: '#/components/schemas/apiPaginationInfo'
    PermissionResponse:
      title: PermissionResponse
      type: object
      properties:
        permission:
          type: string
          description: role name
        description:
          type: string
          description: Description of role
      description: This is a definition for Tessell internal create onboarded acl payload object
    RoleStatus:
      title: RoleStatus
      type: string
      description: This is a definition for Tessell onboarded acl status object
      enum:
      - DELETED
      - ENABLED
  parameters:
    timeZone:
      name: time-zone
      in: query
      description: Timezone for return data
      required: false
      schema:
        type: string
        default: UTC
    pageSize:
      name: page-size
      in: query
      description: Page size for get query
      required: false
      schema:
        type: integer
        format: int32
        default: 10
    pageOffset:
      name: page-offset
      in: query
      description: Page offset for get query
      required: false
      schema:
        type: integer
        format: int32
        default: 0
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer