Shopper Login (SLAS) Admin

GET Retrieve a tenant by tenant ID.

GET /tenants/{tenantId}

Operation ID: retrieveTenant. Security: BearerToken (SLAS_SERVICE_ADMIN, SLAS_ORGANIZATION_ADMIN).

Retrieve a tenant by tenant ID.

Parameters

  • tenantId (path, string, required) The identifier of the SLAS tenant (format: realmId_instanceId).
    Maximum length: 32. Example: zzeu_001, bgvn_dev.

Responses

  • 200 The tenant was retrieved successfully.

    Media type: application/json. Schema: Tenant.

    Example: Tenant

    {
      "createdBy": "slas",
      "modifiedBy": "slas",
      "createdTime": "2021-02-25T00:55:54.119+0000",
      "modifiedTime": "2021-02-25T00:55:54.119+0000",
      "tenantId": "slsa_dev",
      "merchantId": 2,
      "description": "SLAS Default Tenant Two",
      "contact": "Tenant Two",
      "emailAddress": "tenant2@slas.tst",
      "phoneNo": "111-222-4444",
      "tier": "S",
      "requestQuotaPerMinute": 8000,
      "isDeleted": false,
      "status": "CLEAR"
    }
  • 400 Bad request

    Media type: application/json. Schema: ErrorResponse.

    Example: TenantRequestException400

    {
      "type": "TenantRequestException",
      "title": "Unable to retrieve resource because the tenant id was invalid",
      "detail": "Tenant id is invalid"
    }
  • 401 Unauthorized. Wrong tenant

    Media type: application/json. Schema: ErrorResponse.

    Example: TenantException401

    {
      "type": "TenantException",
      "title": "Unable to retrieve resource because the tenant id was invalid",
      "detail": "Tenant id is invalid"
    }
  • 404 Not found

    Media type: application/json. Schema: ErrorResponse.

    Example: TenantNotFoundException404

    {
      "type": "TenantNotFoundException",
      "title": "Unable to retrieve resource because no resource was found with that value",
      "detail": "Tenant id Not Found"
    }