Searching Identity Types

The search REST interface will search the configured database for a list of identities that match the input criteria. The URL needs to be populated with the following information.

• filter defines a set of criteria that controls what is returned by the operation. This is an optional parameter.

• attributes_names defines one or more LDAP attributes for which to search. This is an optional parameter.

• attribute_values_value-of-attributes_names defines the value of the attribute (as defined by attributes_names) that is being searched. This is an optional parameter.

• admin defines the tokenid of the user with the necessary permissions to search; for example amadmin.

The following URL would return the available agent types.

http://OpenSSO-host:OpenSSO-port/opensso/identity/search?filter=*
&attributes_names=objecttype&attributes_values_objecttype=agent
&admin=AQIC5wM2LY4SfcxCWBCNON1gTsaMaHISbYmTyYosv8pCPVw=@AAJTSQACMDE=#

By default:

string=wsc
string=wsp
string=SecurityTokenService

This example would return all user entries.

http://OpenSSO-host:OpenSSO-port/opensso/identity/search?filter=*
&attributes_names=objectclass&attributes_values_objectclass=person
&admin=AQIC5wM2LY4SfcxCWBCNON1gTsaMaHISbYmTyYosv8pCPVw=@AAJTSQACMDE=#

By default:

string=amAdmin
string=amldapuser
string=dsameuser
string=anonymous
string=amService-URLAccessAgent
string=demo

The operation might also return TokenExpired, NeedMoreCredentials, or GeneralFailure on other errors.