Spectro Cloud Roles API

openapi: 3.2.0
info:
  title: Spectro Cloud Roles API
  version: v1
  description: 'Operations tagged roles across 2 of this provider''s published API definitions: spectro-cloud-palette-openapi.json, spectrocloud-palette.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.spectrocloud.com
- url: /
tags:
- name: Roles
  x-displayName: Roles
paths:
  /v1/roles:
    get:
      operationId: v1RolesList
      parameters:
      - description: 'Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name'
        in: query
        name: fields
        schema:
          type: string
      - description: 'Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws


          Server will be restricted to certain fields based on the indexed data for each resource.'
        in: query
        name: filters
        schema:
          type: string
      - description: 'Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1'
        in: query
        name: orderBy
        schema:
          type: string
      - description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.

          If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
        in: query
        name: limit
        schema:
          type: integer
          format: int64
          default: 50
      - description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
        in: query
        name: offset
        schema:
          type: integer
          format: int64
      - description: continue token to paginate the subsequent data items
        in: query
        name: continue
        schema:
          type: string
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Roles'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Retrieves a list of roles
      tags:
      - Roles
    post:
      operationId: v1RolesCreate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Creates a role with specified permissions
      tags:
      - Roles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1Role'
    servers:
    - url: https://api.spectrocloud.com
  /v1/roles/{uid}:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    delete:
      operationId: v1RolesUidDelete
      responses:
        '204':
          description: The resource was deleted successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Deletes the specified role
      tags:
      - Roles
    get:
      operationId: v1RolesUidGet
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Role'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the specified role
      tags:
      - Roles
    put:
      operationId: v1RolesUidUpdate
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Updates the specified role
      tags:
      - Roles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1Role'
    servers:
    - url: https://api.spectrocloud.com
  /v1/roles/{uid}/clone:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    post:
      operationId: v1RolesClone
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Clone the role
      tags:
      - Roles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1RoleClone'
    servers:
    - url: https://api.spectrocloud.com
components:
  schemas:
    v1ObjectMeta:
      description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
      properties:
        annotations:
          additionalProperties:
            type: string
          description: 'Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
          type: object
        creationTimestamp:
          $ref: '#/components/schemas/v1Time'
          description: 'CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.


            Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata'
        deletionTimestamp:
          $ref: '#/components/schemas/v1Time'
          description: 'DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.


            Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata'
        labels:
          additionalProperties:
            type: string
          description: 'Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels'
          type: object
        lastModifiedTimestamp:
          $ref: '#/components/schemas/v1Time'
          description: 'LastModifiedTimestamp is a timestamp representing the server time when this object was last modified. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.


            Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata'
        name:
          description: 'Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
          type: string
        uid:
          description: 'UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.


            Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids'
          type: string
      type: object
    v1RoleCloneMetadata:
      description: Role clone metadata
      properties:
        name:
          type: string
    v1RoleSpec:
      description: Role specifications
      properties:
        permissions:
          items:
            type: string
          type: array
          uniqueItems: true
        scope:
          $ref: '#/components/schemas/v1Scope'
        type:
          enum:
          - system
          - user
          type: string
    v1Uid:
      properties:
        uid:
          type: string
      required:
      - uid
      type: object
    v1Scope:
      enum:
      - system
      - tenant
      - project
      - resource
      type: string
    v1RoleStatus:
      description: Role status
      properties:
        isEnabled:
          description: Specifies if role account is enabled/disabled
          type: boolean
          x-omitempty: false
    v1Roles:
      description: Array of Roles
      properties:
        items:
          items:
            $ref: '#/components/schemas/v1Role'
          type: array
          uniqueItems: true
        listmeta:
          $ref: '#/components/schemas/v1ListMetaData'
      required:
      - items
      type: object
    v1RoleClone:
      description: Role clone specifications
      properties:
        metadata:
          $ref: '#/components/schemas/v1RoleCloneMetadata'
    v1Role:
      description: Role
      properties:
        metadata:
          $ref: '#/components/schemas/v1ObjectMeta'
        spec:
          $ref: '#/components/schemas/v1RoleSpec'
        status:
          $ref: '#/components/schemas/v1RoleStatus'
    v1ListMetaData:
      description: ListMeta describes metadata for the resource listing
      properties:
        continue:
          description: Next token for the pagination. Next token is equal to empty string indicates end of result set.
          type: string
          x-omitempty: false
        count:
          description: Total count of the resources which might change during pagination based on the resources addition or deletion
          type: integer
          x-omitempty: false
        limit:
          description: Number of records feteched
          type: integer
          x-omitempty: false
        offset:
          description: The next offset for the pagination. Starting index for which next request will be placed.
          type: integer
          x-omitempty: false
      type: object
    v1Time:
      description: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.
      format: date-time
      type: string
    v1ObjectMeta_2:
      description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
      example:
        uid: uid
        creationTimestamp: 2000-01-23 04:56:07+00:00
        name: name
        annotations:
          key: annotations
        lastModifiedTimestamp: 2000-01-23 04:56:07+00:00
        deletionTimestamp: 2000-01-23 04:56:07+00:00
        labels:
          key: labels
      properties:
        annotations:
          additionalProperties:
            type: string
          description: 'Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
          type: object
        creationTimestamp:
          description: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.
          format: date-time
          type: string
        deletionTimestamp:
          description: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.
          format: date-time
          type: string
        labels:
          additionalProperties:
            type: string
          description: 'Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels'
          type: object
        lastModifiedTimestamp:
          description: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.
          format: date-time
          type: string
        name:
          description: 'Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
          type: string
        uid:
          description: 'UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.


            Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids'
          type: string
      type: object
    v1RoleCloneMetadata_2:
      description: Role clone metadata
      properties:
        name:
          type: string
      type: object
    v1RoleSpec_2:
      description: Role specifications
      example:
        permissions:
        - permissions
        - permissions
        scope: system
        type: system
      properties:
        permissions:
          items:
            type: string
          type: array
          uniqueItems: true
        scope:
          $ref: '#/components/schemas/v1Scope'
        type:
          enum:
          - system
          - user
          type: string
      type: object
    v1Uid_2:
      example:
        uid: uid
      properties:
        uid:
          type: string
      required:
      - uid
      type: object
    v1RoleStatus_2:
      description: Role status
      example:
        isEnabled: true
      properties:
        isEnabled:
          description: Specifies if role account is enabled/disabled
          type: boolean
          x-omitempty: false
      type: object
    v1Roles_2:
      description: Array of Roles
      example:
        listmeta:
          offset: 1
          continue: continue
          count: 0
          limit: 6
        items:
        - metadata:
            uid: uid
            creationTimestamp: 2000-01-23 04:56:07+00:00
            name: name
            annotations:
              key: annotations
            lastModifiedTimestamp: 2000-01-23 04:56:07+00:00
            deletionTimestamp: 2000-01-23 04:56:07+00:00
            labels:
              key: labels
          spec:
            permissions:
            - permissions
            - permissions
            scope: system
            type: system
          status:
            isEnabled: true
        - metadata:
            uid: uid
            creationTimestamp: 2000-01-23 04:56:07+00:00
            name: name
            annotations:
              key: annotations
            lastModifiedTimestamp: 2000-01-23 04:56:07+00:00
            deletionTimestamp: 2000-01-23 04:56:07+00:00
            labels:
              key: labels
          spec:
            permissions:
            - permissions
            - permissions
            scope: system
            type: system
          status:
            isEnabled: true
      properties:
        items:
          items:
            $ref: '#/components/schemas/v1Role_2'
          type: array
          uniqueItems: true
        listmeta:
          $ref: '#/components/schemas/v1ListMetaData_2'
      required:
      - items
      type: object
    v1RoleClone_2:
      description: Role clone specifications
      properties:
        metadata:
          $ref: '#/components/schemas/v1RoleCloneMetadata_2'
      type: object
    v1Role_2:
      description: Role
      example:
        metadata:
          uid: uid
          creationTimestamp: 2000-01-23 04:56:07+00:00
          name: name
          annotations:
            key: annotations
          lastModifiedTimestamp: 2000-01-23 04:56:07+00:00
          deletionTimestamp: 2000-01-23 04:56:07+00:00
          labels:
            key: labels
        spec:
          permissions:
          - permissions
          - permissions
          scope: system
          type: system
        status:
          isEnabled: true
      properties:
        metadata:
          $ref: '#/components/schemas/v1ObjectMeta_2'
        spec:
          $ref: '#/components/schemas/v1RoleSpec_2'
        status:
          $ref: '#/components/schemas/v1RoleStatus_2'
      type: object
    v1ListMetaData_2:
      description: ListMeta describes metadata for the resource listing
      example:
        offset: 1
        continue: continue
        count: 0
        limit: 6
      properties:
        continue:
          description: Next token for the pagination. Next token is equal to empty string indicates end of result set.
          type: string
          x-omitempty: false
        count:
          description: Total count of the resources which might change during pagination based on the resources addition or deletion
          type: integer
          x-omitempty: false
        limit:
          description: Number of records feteched
          type: integer
          x-omitempty: false
        offset:
          description: The next offset for the pagination. Starting index for which next request will be placed.
          type: integer
          x-omitempty: false
      type: object
  securitySchemes:
    ApiKey:
      description: API key authorization where API key can be generated from Palette console under Profile > My API Keys
      in: header
      name: ApiKey
      type: apiKey
    Authorization:
      description: JWT token authorization obtained using /v1/auth/authenticate api
      in: header
      name: Authorization
      type: apiKey
x-refined-from:
- spectro-cloud-palette-openapi.json
- spectrocloud-palette.yaml