Automated commit 'Merge pull request #1561 from sailpoint/tvorobiova/PLTIN-6036

PLTIN-6036: Added /beta/tenant endpoint API documentation' by github action: 8159405607

idn/beta/paths/tenant.yaml

@@ -0,0 +1,28 @@
+get:
+  operationId: getTenant
+  tags:
+    - Tenant
+  summary: Get Tenant Information.
+  description: >-
+    This rest endpoint can be used to retrieve tenant details.
+  security:
+    - UserContextAuth: [sp:tenant:read]
+  responses:
+    '200':
+      description: Tenant Info
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/Tenant.yaml'
+    '400':
+      $ref: '../../v3/responses/400.yaml'
+    '401':
+      $ref: '../../v3/responses/401.yaml'
+    '403':
+      $ref: '../../v3/responses/403.yaml'
+    '404':
+      $ref: '../../v3/responses/404.yaml'
+    '429':
+      $ref: '../../v3/responses/429.yaml'
+    '500':
+      $ref: '../../v3/responses/500.yaml'

idn/beta/schemas/License.yaml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  licenseId:
+    type: string
+    description: Name of the license
+    example: 'idn:access-request'
+  legacyFeatureName:
+    type: string
+    description: Legacy name of the license
+    example: ACCESS_REQUEST

idn/beta/schemas/Product.yaml

@@ -0,0 +1,88 @@
+type: object
+properties:
+  productName:
+    type: string
+    description: Name of the Product
+    example: idn
+  url:
+    type: string
+    description: URL of the Product
+    example: 'https://tenant-name.identitynow.com'
+  productTenantId:
+    type: string
+    description: An identifier for a specific product-tenant combination
+    example: tenant#product
+  productRegion:
+    type: string
+    description: Product region
+    example: us-east-1
+  productRight:
+    type: string
+    description: Right needed for the Product
+    example: 'idn:ui:view'
+  apiUrl:
+    nullable: true
+    type: string
+    description: API URL of the Product
+    example: 'https://tenant-name.api.identitynow.com'
+  licenses:
+    type: array
+    items:
+      $ref: './License.yaml'
+  attributes:
+    type: object
+    additionalProperties: true
+    description: Additional attributes for a product
+    example: {
+      domain: 'https://tenant-name.identitynow.com',
+      maxRegisteredUsers: 250
+    }
+  zone:
+    type: string
+    description: Zone
+    example: Deployment zone for the Product
+  status:
+    type: string
+    description: Status of the product
+    example: active
+  statusDateTime:
+    type: string
+    format: date-time
+    description: Status datetime
+    example: '2020-05-19T13:49:37.385Z'
+  reason:
+    type: string
+    description: If there's a tenant provisioning failure then reason will have the description of error
+    example: Reason
+  notes:
+    type: string
+    description: Product could have additional notes added during tenant provisioning.
+    example: Example notes
+  dateCreated:
+    nullable: true
+    type: string
+    format: date-time
+    description: Date when the product was created
+    example: '2020-05-19T13:49:37.385Z'
+  lastUpdated:
+    nullable: true
+    type: string
+    format: date-time
+    description: Date when the product was last updated
+    example: '2020-05-19T13:49:37.385Z'
+  orgType:
+    nullable: true
+    type: string
+    enum:
+      - development
+      - staging
+      - production
+      - test
+      - partner
+      - training
+      - demonstration
+      - sandbox
+      - null
+    description: Type of org
+    example: test
+

idn/beta/schemas/Tenant.yaml

@@ -0,0 +1,31 @@
+type: object
+properties:
+  id:
+    type: string
+    readOnly: true
+    description: The unique identifier for the Tenant
+    example: "2c91808568c529c60168cca6f90c1324"
+  name:
+    type: string
+    description: Abbreviated name of the Tenant
+    example: acme
+  fullName:
+    type: string
+    description: Human-readable name of the Tenant
+    example: Acme, Inc
+  pod:
+    type: string
+    description: Deployment pod for the Tenant
+    example: example-pod
+  region:
+    type: string
+    description: Deployment region for the Tenant
+    example: us-east-1
+  description:
+    type: string
+    description: Description of the Tenant
+    example: Description of the Tenant
+  products:
+    type: array
+    items:
+      $ref: './Product.yaml'

idn/sailpoint-api.beta.yaml

@@ -892,6 +892,8 @@ tags:
 
       Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in IdentityNow. 
   - name: Task Management
+  - name: Tenant
+    description: API for reading tenant details.
   - name: Transforms
     description: Operations for creating, managing, and deleting transforms
   - name: Triggers
@@ -1563,6 +1565,8 @@ paths:
     $ref: './beta/paths/bulk-add-tagged-objects.yaml'
   /tagged-objects/bulk-remove:
     $ref: './beta/paths/bulk-remove-tagged-objects.yaml'
+  /tenant:
+    $ref: './beta/paths/tenant.yaml'
   /transforms:
     $ref: './beta/paths/transforms.yaml'
   /transforms/{id}: