4-134 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management
Example
■
IdcCommand command file format: IdcService=ADD_USER
dName=specialuser dUserAuthType=LOCAL
■
HDA format with optional parameters: Properties LocalData
IdcService=ADD_USER dName=jsmith
dUserAuthType=LOCAL dFullName=Jennifer Smith
dPassword=password dEmail=jsmithexample.com
end ResultSet UserAttribInfo
2 dUserName
AttributeInfo jsmith
role,admin,15,role,contributor,15 end
4.14.5 CHANGE_USER_AUTH_TYPE
Service that changes the authentication type global, local, or external for users. Location: IdcHomeDirresourcescoretemplatesstd_services.htm
Additional Required Service Parameters
■
curUserAuthType: Current user authentication type.
■
dUserAuthType: New user authentication type.
4.14.6 CHECK_USER_CREDENTIALS
Service that checks the credentials of a user. You can use this service to get information about a user for example, roles and accounts, or use it to check a userpassword pair
to see if they match. This is called during the authentication process. The data is cached so it is not called for every service request.
This service does not return user data for Microsoft Active Directory managed users when the Oracle Content Server instance is configured to use ADSI. It does return the
user data for local users and external LDAP managed users.
Access Level: NA 0 Location: IdcHomeDirresourcescoretemplatesstd_services.htm
Additional Required Service Parameters
■
userName: The user name
Optional Service Parameters
■
getUserInfo: 0 false: Does not retrieve extended user information. 1 true: Retrieves extended user information full name, e-mail address, locale, and user
type
Core Oracle Content Server Services 4-135
■
hasSecurityInfo: 0 false: Retrieves the user accounts. 1 true: Does not retrieve the user accounts.
■
authenticateUser: 0 false: Does not authenticate the user validate that the userpassword pair match. 1 true: Authenticates the user validate that the
userpassword pair match. In this case, the userPassword parameter must be specified.
■
userPassword: The password for the specified user name. If the authenticateUser parameter is included and set to 1 true, the userPassword parameter must be
specified.
■
userExtendedInfo: This parameter, combined with the getUserInfo parameter, returns the users accounts and groups in the data binder. 0 false: Does not
retrieve the information. 1 true: Retrieves the information.
Results
■
Local Data:
– extendedInfo: HDA-encoded string containing user info fields ndUserLocale,
nblFieldTypes, ndEmail, nblDateFormat, ndFullName, ndUserType, ndUserAuthType, ndUserChangeDate, ndUserTimeZone, and
ndUserArriveDate. Only returned if optional parameter getUserInfo is 1 true.
– accounts: comma-delimited list of users accounts. Only returned if optional
parameter hasSecurityInfo is 0 false.
– roles: comma-delimited list if users roles. Only returned if optional parameter
hasSecurityInfo is 0 false.
– hasSecurtyInfo: Returns 1 true if security information is present in response.
– isAuthenticated: Returns 1 true if optional parameter authenticateUser is set
to 1 true, and the optional parameter userPassword matches the password that corresponds to userName.
– isPromptLogin: Returns 1 true if userPassword does not correspond to
userName. No other data is returned in this situation.
Example The following is an example CHECK_USER_CREDENTIALS service call to get
information about a user:
Properties LocalData IdcService=CHECK_USER_CREDENTIALS
userName=user1 getUserInfo=1
end
The following is an example of the results that would be returned by this service call to get user information note that the accounts are returned:
Content-type: textplain ?hda version=6.3 dev build-date jcharset=Cp1252 encoding=iso-8859-1?
Properties LocalData dUser=user1
blFieldTypes= dUserOrgPath=
refreshSubMonikers= accounts=none,prjRWD
4-136 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management
blDateFormat={ts yyyy-MM-dd HH:mm:ss}tAmericaChicago StatusCode=0
dUserSourceOrgPath= hasSecurityInfo=1
roles=contributor refreshSubjects=
changedSubjects= dName=user1
refreshMonikers= changedMonikers=
extendedInfo=\Properties LocalData\nu9=\nu8=\nu7=\ndUserArriveDate= {ts 2003-02-11 08:34:35}\nu6=\ndUserTimeZone=\nu5=\nu4=\nu3=\nu2=
\ndUserAuthType=LOCAL\nu1=\ndUserType=\ndUserChangeDate={ts 2003-04-03 11:57:29} \nuPhone=\nuCompany=\ndUserLocale=English-US\nblFieldTypes=\nu24=\nu23=\nu22=
\nu21=\nu20=\ndFullName=user1\nblDateFormat=Md{yyyy} {h:mm{:ss}{.SSSS} {aa}}tAmericaChicago\ndEmail=\nu19=\nu18=\nu17=\nu16=\nu15=\nu14=\nu13=\nu12=
\nu11=\nu10=\n\end\n\n end
The following is an example of the results that would be returned by this service call to get user information note that the accounts are not returned:
Content-type: textplain ?hda version=6.3 dev build-date jcharset=Cp1252 encoding=iso-8859-1?
Properties LocalData dUser=user1
blFieldTypes= refreshSubMonikers=
blDateFormat={ts yyyy-MM-dd HH:mm:ss}tAmericaChicago StatusCode=0
changedSubjects= refreshSubjects=
dName=user1 changedMonikers=
refreshMonikers= extendedInfo=\Properties LocalData\nu9=\nu8=\nu7=\ndUserArriveDate=
{ts 2003-02-11 08:34:35}\nu6=\ndUserTimeZone=\nu5=\nu4=\nu3=\nu2= \ndUserAuthType=LOCAL\nu1=\ndUserType=\ndUserChangeDate={ts 2003-04-03
11:57:29}\nuPhone=\nuCompany=\ndUserLocale=English-US\nblFieldTypes=\nu24=\nu23= \nu22=\nu21=\nu20=\ndFullName=user1\nblDateFormat=Md{yyyy} {h:mm{:ss}{.SSSS}
{aa}}tAmericaChicago\ndEmail=\nu19=\nu18=\nu17=\nu16=\nu15=\nu14=\nu13=\nu12= \nu11=\nu10=\n\end\n\n
end
The following is an example CHECK_USER_CREDENTIALS service call to see if a user namepassword pair match:
Properties LocalData IdcService=CHECK_USER_CREDENTIALS
userName=user1 authenticateUser=1
userPassword=idc end
The following is an example of the results that would be returned by this service call to check a user namepassword pair match note that the user name and password
match; the key returned value being isAuthenticated=1:
Content-type: textplain ?hda version=6.3 dev build-date jcharset=Cp1252 encoding=iso-8859-1?
Properties LocalData
Core Oracle Content Server Services 4-137
dUser=user1 blFieldTypes=
refreshSubMonikers= blDateFormat={ts yyyy-MM-dd HH:mm:ss}tAmericaChicago
StatusCode=0 changedSubjects=
refreshSubjects= dName=user1
changedMonikers= refreshMonikers=
isAuthenticated=1 end
The following is another example CHECK_USER_CREDENTIALS service call to see if a user namepassword pair match:
Properties LocalData IdcService=CHECK_USER_CREDENTIALS
userName=user1 authenticateUser=1
userPassword=pppp end
The following is an example of the results that would be returned by this service call to check a user namepassword pair match note that the user name and password do
not match; isPromptLogin=1 is returned instead of isAuthenticated=1:
Content-type: textplain ?hda version=6.3 dev build-date jcharset=Cp1252 encoding=iso-8859-1?
Properties LocalData dUser=user1
blFieldTypes= refreshSubMonikers=
blDateFormat={ts yyyy-MM-dd HH:mm:ss}tAmericaChicago StatusCode=0
isPromptLogin=1 changedSubjects=
refreshSubjects= dName=user1
changedMonikers= refreshMonikers=
end
4.14.7 DELETE_ALIAS
