# Tenant Management

Overview

The Tenant Management API provides comprehensive capabilities for managing tenant accounts, administrators, authentication methods, and access delegation in RUCKUS cloud. This API enables you to configure tenant settings, manage administrator access with role based permissions, control delegation relationships, and customize user preferences.

The API is designed for organizations that need to manage tenant configurations, control administrator assignments, configure authentication methods, and establish delegation relationships with support teams or value added reseller partners.

What This API Does

- Tenant Configuration: Retrieve and update tenant information including organization details, service tier settings, and branding preferences
- Administrator Management: Create, retrieve, update, and delete administrator accounts with role assignments, privilege group configurations, and granular permission control
- Delegation Management: Manage delegation relationships with RUCKUS customer support, value added reseller partners, managed service providers, integrators, and installers for temporary or ongoing access
- User Profile: Retrieve and update user profile settings including contact information, regional preferences, and application preferences
- Authentication: Configure and manage OAuth and SAML authentication providers with domain mapping capabilities
- Notifications: Configure notification recipients and delivery endpoints for email, SMS, and mobile push notifications
- Query Operations: Retrieve administrator and notification recipient data with pagination, sorting, and filtering
- Privacy Features: Manage privacy feature settings for compliance and data protection requirements
- Beta Features: Enable or disable beta features for early access to new functionality
- Account Information: Retrieve detailed account information including organization details and location data

Common Use Cases

- Enterprise Tenant Management: Configure tenant settings and branding for large organizations with multiple administrators
- Regional Deployment: Manage tenant configurations across North America, Europe, and Asia Pacific regions
- Partner Support Access: Enable temporary or ongoing access for support teams and service providers
- Compliance Management: Control privacy settings and data protection features to meet regulatory requirements

Technical Details

- API Version: v0.3.0
- Content Types: Supports application/json and application/vnd.ruckus.v1+json for v1 endpoints
- Regional Endpoints: Available in North America, Europe, and Asia Pacific regions

Authentication & Authorization

This API uses bearer token authentication with role based access control. Administrators must have appropriate permissions to perform operations on tenant accounts, administrator records, and delegation relationships.


Version: v0.3.0
License: RUCKUS Cloud Privacy Policy

## Servers

RUCKUS One API host for North American region.
```
https://api.ruckus.cloud
```

RUCKUS One API host for Asian region.
```
https://api.asia.ruckus.cloud
```

RUCKUS One API host for European region.
```
https://api.eu.ruckus.cloud
```

## Download OpenAPI description

[Tenant Management](https://docs.ruckus.cloud/_bundle/api/ptenant-0.3.0.yaml)

## Notification Recipient

Manage notification recipient configurations for tenants.

### Query Notification Recipients

 - [POST /tenants/notifications/recipients/query](https://docs.ruckus.cloud/api/ptenant-0.3.0/notification-recipient/querynotificationrecipients.md): Query notification recipient list.

### Get Notification Recipients

 - [GET /tenants/notificationRecipients](https://docs.ruckus.cloud/api/ptenant-0.3.0/notification-recipient/getnotificationrecipients.md): Get notification recipient list.

### Add Notification Recipient

 - [POST /tenants/notificationRecipients](https://docs.ruckus.cloud/api/ptenant-0.3.0/notification-recipient/addnotificationrecipient.md): Add a new notification recipient to the tenant.

### Delete Notification Recipient

 - [DELETE /tenants/notificationRecipients](https://docs.ruckus.cloud/api/ptenant-0.3.0/notification-recipient/deletenotificationrecipients.md): Delete notification recipient list.

## Administrator

Manage administrator accounts and roles.

### Get Administrator

 - [GET /admins](https://docs.ruckus.cloud/api/ptenant-0.3.0/administrator/getadminlist.md): Get list of administrators.

### Update Administrator

 - [PUT /admins](https://docs.ruckus.cloud/api/ptenant-0.3.0/administrator/updateadminrole.md): Update administrator role and settings for the tenant.

### Add Administrator

 - [POST /admins](https://docs.ruckus.cloud/api/ptenant-0.3.0/administrator/addadmin.md): Add a new administrator to the tenant.

### Delete Administrators

 - [DELETE /admins](https://docs.ruckus.cloud/api/ptenant-0.3.0/administrator/deletebulkadmin.md): Delete administrators in bulk.

### Get Administrator

 - [POST /admins/query](https://docs.ruckus.cloud/api/ptenant-0.3.0/administrator/queryadminlist.md): Get list of administrators.

### Get Administrator

 - [GET /admins/{adminId}](https://docs.ruckus.cloud/api/ptenant-0.3.0/administrator/getadminbyid.md): Get administrator by identifier.

### Delete Administrator

 - [DELETE /admins/{adminId}](https://docs.ruckus.cloud/api/ptenant-0.3.0/administrator/deleteadmin.md): Delete administrator by identifier.

## Delegation

Manage tenant delegation access rights.

### Get Delegation

 - [GET /tenants/delegations/{delegationId}](https://docs.ruckus.cloud/api/ptenant-0.3.0/delegation/getdelegation.md): Get delegation by ID.

### Respond to Delegation

 - [PUT /tenants/delegations/{delegationId}](https://docs.ruckus.cloud/api/ptenant-0.3.0/delegation/acceptorrejectdelegation.md): A VAR uses this endpoint to respond to a delegation invitation; the response is either accept or reject.

### Revoke VAR Delegation

 - [DELETE /tenants/delegations/{delegationId}](https://docs.ruckus.cloud/api/ptenant-0.3.0/delegation/deletedelegation.md): Revoke VAR delegation by ID.

### Grant Access

 - [POST /tenants/supportDelegations](https://docs.ruckus.cloud/api/ptenant-0.3.0/delegation/invitesupport.md): Grant RUCKUS customer support access to my account.

### Revoke Access

 - [DELETE /tenants/supportDelegations](https://docs.ruckus.cloud/api/ptenant-0.3.0/delegation/deletesupportdelegation.md): Revoke RUCKUS customer support's access to my account.

### Get Delegations

 - [GET /tenants/delegations](https://docs.ruckus.cloud/api/ptenant-0.3.0/delegation/getdelegations.md): Get delegation list for the authenticated tenant.

### Invite VAR

 - [POST /tenants/delegations](https://docs.ruckus.cloud/api/ptenant-0.3.0/delegation/invitevar.md): Send invitation to VAR (aka delegate) to manage my account.This operation is not supported using client credentials.

## Privacy Features

Manage tenant privacy feature settings.

### Get Configured Privacy Settings

 - [GET /tenants/privacySettings](https://docs.ruckus.cloud/api/ptenant-0.3.0/privacy-features/getprivacysettings.md): Get configured privacy settings.

### Clear and Save Privacy Settings

 - [POST /tenants/privacySettings](https://docs.ruckus.cloud/api/ptenant-0.3.0/privacy-features/postprivacysettings.md): Clear and save privacy settings.

### Add or Update Privacy Settings

 - [PATCH /tenants/privacySettings](https://docs.ruckus.cloud/api/ptenant-0.3.0/privacy-features/patchprivacysettings.md): Configure, add or update tenant specific privacy settings such as arc, visibility controls and related features.

## User Profile

Manage administrator user profile settings.

### Get User Profile

 - [GET /tenants/userProfiles](https://docs.ruckus.cloud/api/ptenant-0.3.0/user-profile/getuserprofile.md): Get user profile for the authenticated administrator.

### Update User Profile

 - [PUT /tenants/userProfiles](https://docs.ruckus.cloud/api/ptenant-0.3.0/user-profile/updateuser.md): Update user profile settings for the authenticated administrator.

### Get Account

 - [GET /tenants/accounts](https://docs.ruckus.cloud/api/ptenant-0.3.0/user-profile/getaccountdetails.md): Get account details for the authenticated administrator.

## Tenant

Manage tenant accounts and configurations.

### Get Tenant

 - [GET /tenants/self](https://docs.ruckus.cloud/api/ptenant-0.3.0/tenant/get.md): Get tenant by identifier.

### Update a Tenant

 - [PUT /tenants/self](https://docs.ruckus.cloud/api/ptenant-0.3.0/tenant/updatetenant.md): Update tenant information such as tenant name, tenant type, and external identifier.

### Get Beta Feature Identifiers

 - [GET /tenants/betaFeatures](https://docs.ruckus.cloud/api/ptenant-0.3.0/tenant/getfeatureids.md): Get list of beta features.

### Update Beta Feature Identifiers

 - [PUT /tenants/betaFeatures](https://docs.ruckus.cloud/api/ptenant-0.3.0/tenant/updatefeatureids.md): Update beta feature identifiers.

## acx-mobile-push-notification-endpoint-controller

### Add Mobile Push Notification

 - [POST /tenants/mobilePushNotifications](https://docs.ruckus.cloud/api/ptenant-0.3.0/acx-mobile-push-notification-endpoint-controller/addmobilepushnotifications.md): Add mobile push notification.

## authentication-controller

### Get Authentications

 - [GET /tenants/authentications](https://docs.ruckus.cloud/api/ptenant-0.3.0/authentication-controller/getauthentications.md): Get all authentication configurations for the tenant.

### Add Authentication

 - [POST /tenants/authentications](https://docs.ruckus.cloud/api/ptenant-0.3.0/authentication-controller/addauthentication.md): Add a new authentication configuration for the tenant.