All parameters are required unless otherwise stated.
Field
Description
Type
Notes
<authnprovider_update>
<server_url_changes>
<add>
List of Server URLs to add. You cannot mix ldap and ldaps URLs
<server_url>
String
0-* Elements
</add>
<remove>
List of Server URLs to remove.
<server_url>
String
0-* Elements
</remove>
</server_url_changes>
<domain_changes>
<add>
List of domains to add.
<domain>
String
0-* Elements
</add>
<remove>
List of domains to remove.
<domain>
String
0-* Elements
</remove>
</domain_changes>
<group_whitelist_value_changes>
<add>
List of white list values to add.
<group_whitelist_value>
String
0-* Elements
</add>
<remove>
List of white list values to remove.
<group_whitelist_value>
String
0-* Elements
</remove>
</group_whitelist_value_changes>
<tenants_synchronization_options_changes>
<add>
List of tenants synchronization options to add.
<tenantsSynchronizationOptions>
String
0-* Elements
</add>
<remove>
List of tenants synchronization options to remove.
<tenantsSynchronizationOptions>
String
0-* Elements
</remove>
</tenants_synchronization_options_changes>
<group_objclass_changes>
<add>
List of group object classes to add.
<group_object_class>
String
0-* Elements
</add>
<remove>
List of group object classes to remove.
<group_object_class>
String
0-* Elements
</remove>
</group_objclass_changes>
<group_memberattr_changes>
<add>
List of group member attributes to add.
<group_member_attribute>
String
0-* Elements
</add>
<remove>
List of group member attribute type names to remove.
<group_member_attribute>
String
0-* Elements
</remove>
</group_memberattr_changes>
<mode>
String
<name>
String
Valid Values:
Length: 2..128
<description>
String
<disable>
Boolean
<autoreg_coprhd_import_osprojects>
Boolean
<manager_dn>
String
<manager_password>
String
<search_base>
String
<search_filter>
String
<search_scope>
String
<group_attribute>
String
<max_page_size>
Integer
<validate_certificates>
Boolean
</authnprovider_update>
Response Body
Provider details with updated values
Field
Description
Type
Notes
<authnprovider>
<description>
Description of the provider
String
<disable>
Specifies if a provider is disabled or enabled.
During the operation of the system, a disabled provider will exist but
not be considered when authenticating principals.
Boolean
<autoreg_coprhd_import_osprojects>
Specifies if OpenStack Projects will be auto-registered as Tenants in CoprHD.
Boolean
<tenants_synchronization_options>
<tenants_synchronization_option>
String
0-* Elements
</tenants_synchronization_options>
<domains>
<domain>
String
0-* Elements
</domains>
<group_attribute>
Attribute for group search. This is the attribute name that will be used to represent group membership.
String
<group_whitelist_values>
<group_whitelist_value>
String
0-* Elements
</group_whitelist_values>
<manager_dn>
Distinguished Name for the bind user.
String
<max_page_size>
Maximum number of results that the LDAP server will return on a single page.
Valid value:
Value must be greater than 0 and cannot be higher than the max page size configured on LDAP server.
Integer
<mode>
String
<search_base>
Search base from which the LDAP search will start when authenticating
users. See also: search_scope
String
<search_filter>
Key value pair representing the search filter criteria.
user. %u is user@company.com)
String
<search_scope>
In conjunction with the search_base, the search_scope indicates how many
levels below the base the search can continue.
Valid values:
ONELEVEL = The search will start at the search_base location and continue up to one level deep
SUBTREE = The search will start at the search_base location and continue through the entire tree
String
<server_urls>
<server_url>
String
0-* Elements
</server_urls>
<group_object_classes>
Attribute for group's objectClass search. This is the attribute name that will be used to represent group's name.
<group_object_class>
String
0-* Elements
</group_object_classes>
<group_member_attributes>
Attribute for group's member search. This is the attribute name that will be used to represent group members.
<group_member_attribute>
String
0-* Elements
</group_member_attributes>
<name>
The name assigned to this resource in ViPR. The resource name is set by
a user and can be changed at any time. It is not a unique identifier.
String
<id>
An identifier that is generated by ViPR when the resource is created.
The resource ID is guaranteed to be unique and immutable across all
virtual data centers for all time.
URI
<link>
A hyperlink to the details for this resource
<creation_time>
A timestamp that shows when this resource was created in ViPR
DateTime
<tags>
Keywords and labels that can be added by a user to a resource
to make it easy to find when doing a search.
<tag>
String
0-* Elements
</tags>
<inactive>
Whether or not the resource is inactive. When a user removes
a resource, the resource is put in this state before
it is removed from the ViPR database.
Boolean
<global>
Boolean
<remote>
Boolean
<vdc>
<id>
ViPR ID of the related object
URI
<link>
A hyperlink to the related object
</vdc>
<internal>
Whether or not the resource is an internal resource.