Resource Fields

Writeable Fields

Field Type Create Update Default Notes
accessMode string Yes - unrestricted  
allowedIdentities array[identity] Optional - -  
connectionTimeout int Yes - 1000  
domain string Yes - -  
enabled boolean Optional - -  
groupDNField string Optional - entryDN  
groupMemberMappingAttribute string Yes - memberUid  
groupMemberUserAttribute string Optional - entryDN  
groupNameField string Yes - cn  
groupObjectClass string Yes - posixGroup  
groupSearchDomain string Optional - -  
groupSearchField string Yes - cn  
loginDomain string Optional - -  
port int Yes - 389  
server string Yes - -  
serviceAccountPassword string Yes - -  
serviceAccountUsername string Yes - -  
tls boolean Yes - -  
userDisabledBitMask int Optional - -  
userEnabledAttribute string Optional - -  
userLoginField string Yes - uid  
userMemberAttribute string Yes - memberOf  
userNameField string Yes - givenName  
userObjectClass string Yes - inetOrgPerson  
userSearchField string Yes - uid  

Read Only Fields

Field Type Notes
name string  

Please read more about the common resource fields. These fields are read only and applicable to almost every resource. We have segregated them from the list above.


CreatePOST: /v2-beta/projects/${PROJECT_ID}/openldapconfigs

-H 'Content-Type: application/json' \
-d '{
	"accessMode": "unrestricted",
	"allowedIdentities": "array[identity]",
	"connectionTimeout": 1000,
	"domain": "string",
	"enabled": false,
	"groupDNField": "entryDN",
	"groupMemberMappingAttribute": "memberUid",
	"groupMemberUserAttribute": "entryDN",
	"groupNameField": "cn",
	"groupObjectClass": "posixGroup",
	"groupSearchDomain": "string",
	"groupSearchField": "cn",
	"loginDomain": "string",
	"port": 389,
	"server": "string",
	"serviceAccountPassword": "string",
	"serviceAccountUsername": "string",
	"tls": false,
	"userDisabledBitMask": 0,
	"userEnabledAttribute": "string",
	"userLoginField": "uid",
	"userMemberAttribute": "memberOf",
	"userNameField": "givenName",
	"userObjectClass": "inetOrgPerson",
	"userSearchField": "uid"
}' 'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/openldapconfigs'

UpdatePUT: /v2-beta/projects/${PROJECT_ID}/openldapconfigs/${ID}

-X PUT \
-H 'Content-Type: application/json' \
-d '{}' 'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/openldapconfigs/${ID}'
Edit this page