# External Authentication Service

# Overview

The External Authentication Service REST API provides enterprise identity management for authentication in RUCKUS Cloud WiFi environments.

## Key Features

- **SAML Identity Provider Management**: Create, retrieve, update, and delete SAML IdP profiles
- **Certificate Management**: Manage encryption and signing certificates with activation and deactivation controls

This API enables network administrators to integrate enterprise identity providers with RUCKUS Cloud WiFi for secure user authentication across wireless networks.


Version: 0.0.1
License: RUCKUS Cloud Privacy Policy

## Servers

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

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

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

## Download OpenAPI description

[External Authentication Service](https://docs.ruckus.cloud/_bundle/api/external-auth-0.0.1.yaml)

## Directory Profile

Manage directory server profiles for LDAP and active directory integration enabling enterprise user authentication and authorization.

### Create Directory Server Profile

 - [POST /directoryServerProfiles](https://docs.ruckus.cloud/api/external-auth-0.0.1/directory-profile/adddirectoryserverprofile.md): Create a new directory server profile for LDAP or active directory integration enabling enterprise user authentication.

### Delete

 - [DELETE /directoryServerProfiles/{directoryServerProfileId}](https://docs.ruckus.cloud/api/external-auth-0.0.1/directory-profile/deletedirectoryserverprofile.md): Delete an existing directory server profile removing LDAP or active directory integration configuration from the system.

### Get Directory Server Profile

 - [GET /directoryServerProfiles/{directoryServerProfileId}](https://docs.ruckus.cloud/api/external-auth-0.0.1/directory-profile/getdirectoryserverprofile.md): Retrieve detailed configuration information for a specific directory server profile using the unique profile identifier.

### Update Directory Server Profile

 - [PUT /directoryServerProfiles/{directoryServerProfileId}](https://docs.ruckus.cloud/api/external-auth-0.0.1/directory-profile/updatedirectoryserverprofile.md): Update the configuration settings of an existing directory server profile for LDAP or active directory integration.

## SAML Identity Provider

Manage SAML identity providers.

### Create SAML Identity Provider Profile

 - [POST /samlIdpProfiles](https://docs.ruckus.cloud/api/external-auth-0.0.1/saml-identity-provider/createsamlidpprofile.md): Create a SAML identity provider profile.

### Delete SAML Identity Provider Profile

 - [DELETE /samlIdpProfiles/{samlIdpProfileId}](https://docs.ruckus.cloud/api/external-auth-0.0.1/saml-identity-provider/deletesamlidpprofile.md): Delete the specified SAML identity provider profile.

### Get SAML Identity Provider Profile

 - [GET /samlIdpProfiles/{samlIdpProfileId}](https://docs.ruckus.cloud/api/external-auth-0.0.1/saml-identity-provider/getsamlidpprofile.md): Retrieve the specified SAML identity provider profile.

### Update Partial SAML Profile

 - [PATCH /samlIdpProfiles/{samlIdpProfileId}](https://docs.ruckus.cloud/api/external-auth-0.0.1/saml-identity-provider/samlidpprofileaction.md): Update the specified partial SAML identity provider profile.

### Update Entire SAML Profile

 - [PUT /samlIdpProfiles/{samlIdpProfileId}](https://docs.ruckus.cloud/api/external-auth-0.0.1/saml-identity-provider/updatesamlidpprofile.md): Update the specified entire SAML identity provider profile.

### Deactivate Encryption Certificate

 - [DELETE /samlIdpProfiles/{samlIdpProfileId}/encryptionCertificates/{certificateId}](https://docs.ruckus.cloud/api/external-auth-0.0.1/saml-identity-provider/deactivateencryptioncertificateonsamlidpprofile.md): Deactivates the specified encryption certificate for the SAML identity provider profile.

### Activate Encryption Certificate

 - [PUT /samlIdpProfiles/{samlIdpProfileId}/encryptionCertificates/{certificateId}](https://docs.ruckus.cloud/api/external-auth-0.0.1/saml-identity-provider/activateencryptioncertificateonsamlidpprofile.md): Activates the specified encryption certificate for the SAML identity provider profile.

### Deactivate Signing Certificate

 - [DELETE /samlIdpProfiles/{samlIdpProfileId}/signingCertificates/{certificateId}](https://docs.ruckus.cloud/api/external-auth-0.0.1/saml-identity-provider/deactivatesigningcertificateonsamlidpprofile.md): Deactivates the specified signing certificate for the SAML identity provider profile.

### Activate Signing Certificate

 - [PUT /samlIdpProfiles/{samlIdpProfileId}/signingCertificates/{certificateId}](https://docs.ruckus.cloud/api/external-auth-0.0.1/saml-identity-provider/activatesigningcertificateonsamlidpprofile.md): Activates the specified signing certificate for the SAML identity provider profile.