All URIs are relative to https://localhost/cloudapi
| Method | HTTP request | Description |
|---|---|---|
| SearchLdapGroups | Get /1.0.0/ldap/search/group | Search LDAP Groups |
| SearchLdapUsers | Get /1.0.0/ldap/search/user | Search LDAP Users |
| SyncLdap | Post /1.0.0/ldap/sync | Synchronize LDAP users/settings |
| TestLdap | Post /1.0.0/ldap/test | Tests LDAP Connection and Settings |
[]UserGroup SearchLdapGroups(ctx, optional) Search LDAP Groups
Searches LDAP for given group(s)
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *LDAPApiSearchLdapGroupsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a LDAPApiSearchLdapGroupsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| q | optional.String | String to search for via LDAP |
- Content-Type: Not defined
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]User SearchLdapUsers(ctx, optional) Search LDAP Users
Searches LDAP for given user(s)
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *LDAPApiSearchLdapUsersOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a LDAPApiSearchLdapUsersOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| q | optional.String | String to search for via LDAP |
- Content-Type: Not defined
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SyncLdap(ctx, ) Synchronize LDAP users/settings
Begins the LDAP sync task
This endpoint does not need any parameter.
(empty response body)
- Content-Type: Not defined
- Accept: /;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LdapTestResult TestLdap(ctx, ldapSettings, optional) Tests LDAP Connection and Settings
Tests that custom LDAP settings are valid, and that the system can use them to search for a user or group
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| ldapSettings | LdapSettings | LDAP Settings to use for testing connection | |
| optional | *LDAPApiTestLdapOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a LDAPApiTestLdapOpts struct
| Name | Type | Description | Notes |
|---|
username | optional.String| Username to use when testing LDAP search |
- Content-Type: application/json
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]