Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Cloud Service Automation4.80.0002

Develop > Application Programming Interface > Legacy APIs > Login API > Get userIdentifier

Get userIdentifier

Details

URI	`/login/<organization_name>/<user_name>/` Where <organization_name> is the desired organization name and <user_name> is the desired user name in that organization, to generate a user identifier.
Method	GET
Returns	200 - Ok 401 - Not authorized 404 - Not found 500 - Server exception

Note Unlike most API calls, the arguments (organization name and user name) are part of the URL path rather than parameters.

Caution If the trailing slash is not included, a portion of the user name might be truncated when the user name includes non-alphanumeric characters. The best practice is to always include a trailing slash.

Example

To get the userIdentifier, we used the following URL:

https://<host>:<port>/csa/rest/login/MyOrganization/admin/

The following XML was returned in the response:


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<person>
    <id>90s96588670da0c701360da0f1d540a1</id> <!-- This is userIdentifier -->
    ... <!-- Remaining XML is not relevant for this example. -->
</person>

The value for userIdentifier is the first <id> value returned in the XML.

Send Help Center feedback