Merge pull request #9306 from traci-morrison/jira-engdocs-111

Change API URL to 3.2
This commit is contained in:
Traci Morrison 2019-08-29 10:52:10 -04:00 committed by GitHub
commit 50ba65fac7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions

View File

@ -17,13 +17,13 @@ all manually created users whose usernames don't match any LDAP search results
are still available.
When you enable LDAP authentication, you can choose whether UCP creates user
accounts only when users log in for the first time. Select the
accounts only when users log in for the first time. Select the
**Just-In-Time User Provisioning** option to ensure that the only LDAP
accounts that exist in UCP are those that have had a user log in to UCP.
## How UCP integrates with LDAP
You control how UCP integrates with LDAP by creating searches for users.
You control how UCP integrates with LDAP by creating searches for users.
You can specify multiple search configurations, and you can specify multiple
LDAP servers to integrate with. Searches start with the `Base DN`, which is
the *distinguished name* of the node in the LDAP directory tree where the
@ -44,7 +44,7 @@ and servers.
server is considered the default domain server. Any others are associated
with the domain that you specify in the page.
Here's what happens when UCP synchronizes with LDAP:
Here's what happens when UCP synchronizes with LDAP:
1. UCP creates a set of search results by iterating over each of the user
search configs, in the order that you specify.
@ -82,7 +82,7 @@ Here are three user search configs with the following `Base DNs`:
For this search config, two of the domain servers have a domain which is a
suffix of this base DN, but `dc=subsidiary2,dc=subsidiary1,dc=com` is the
longer of the two, so UCP uses the server `ldaps://ldap.subsidiary2.com`
longer of the two, so UCP uses the server `ldaps://ldap.subsidiary2.com`
for the search request.
- baseDN=`ou=eng,dc=example,dc=com`
@ -127,7 +127,7 @@ remain unchanged for all existing users.
## LDAP enabled
Click **Yes** to enable integrating UCP users and teams with LDAP servers.
Click **Yes** to enable integrating UCP users and teams with LDAP servers.
## LDAP server
@ -198,7 +198,7 @@ You can also manually synchronize users by clicking **Sync Now**.
## Revoke user access
When a user is removed from LDAP, the effect on the user's UCP account depends
on the **Just-In-Time User Provisioning** setting:
on the **Just-In-Time User Provisioning** setting:
- **Just-In-Time User Provisioning** is `false`: Users deleted from LDAP become
inactive in UCP after the next LDAP synchronization runs.
@ -225,9 +225,9 @@ LDAP directory.
As of UCP 3.1.5, LDAP-specific `GET` and `PUT` API endpoints have been added to the Config resource. Note that swarm mode has to be enabled before you can hit the following endpoints:
- `GET /api/ucp/config/auth/ldap` - Returns information on your current system LDAP configuration.
- `PUT /api/ucp/config/auth/ldap` - Lets you update your LDAP configuration.
- `PUT /api/ucp/config/auth/ldap` - Lets you update your LDAP configuration.
See [UCP API Documentation](/reference/ucp/3.1/api/) for additonal information.
See [UCP API Documentation](/reference/ucp/3.2/api/) for additonal information.
## Where to go next