- General Information
- Connecting Third-party Systems
- crossConnect for content systems
- crossConnect for External Editing
- Purpose and usage
- Requirements
- Implementation
- Across XLIFF format
- Across-specific Extensions
- <xliff> Element Attributes
- <file> Element Extensions
- <trans-unit> Element Extension
- Paragraph States
- Paragraph State Flags
- <source> and <target> Element Content
- <bpt> Element Attributes
- <ph> Element Attributes
- <x> Element Attributes
- Across-specific Properties
- Analysis Results
- Sample Files
- Across XLIFF - import, export and segmentation
- Context information
- Exporting best matches in Across XLIFF
- Hyperlinks to XLIFF
- Secure file handling with C#
- Secure file handling with JAVA
- Workflow and vendor configuration
- Sample code - Integrated solution
- Across XLIFF format
- Generic File Connector
- Display Texts
- APIs
- APIs - Technology
- crossTank API v1
- crossTank API v2
- crossTerm API v1
- crossTerm API v2
- crossAPI SI
- Requirements
- Function Return Types
- crossAPI SI and Java
- List of Objects in crossAPI SI
- Sample - transferring checkout files via FileManager
- Sample - VBS
- Text Preprocessing API
Authorization
- Unless stated otherwise, all objects are available in the following Across versions:
- 5.7
- 6.0
- 6.3
- 7.0
Function-specific return values are listed with each function.
For more information on return values and a complete list of error codes, see Function Return Types.
Function | Description |
Changes the password of a user. | |
Creates a security token to get access to crossAPI SI functionality. This security token is expected from the majority of the crossAPI SI functions as first parameter. | |
Creates a Security Token with a custom authentication plugin. | |
Returns all the available authentication methods. The authentication methods are the custom authentication plugins. | |
Returns the GUID of the respective user according to the security token. | |
Checks if the specified user is currently logged in. | |
Sets the password for the specified user. | |
Verifies that the license assigned to the specified user is active. | |
Verifies the supplied login data. | |
Verifies the supplied login data. | |
Verifies the supplied login data. | |
Verifies the supplied login data with a custom authentication plugin. | |
Verifies the supplied login data with a custom authentication plugin. | |
Verifies the supplied login data with a custom authentication plugin. |
Authorization.ChangeUserPassword
Changes the password of a user.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | Login | The users login, the username. |
3 | string | Password | The password of the user. |
4 | string | NewPassword | The new password of the user. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 2 | User does not exist. |
Error | 159 | Cannot change user password. |
Authorization.CreateSecurityToken
Creates a security token to get access to crossAPI SI functionality. This security token is expected from the majority of the crossAPI SI functions as first parameter.
Parameters
Type | Name | Description | |
1 | string | UserName | The username. |
2 | string | Password | The password of the user. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The security token. |
Error | 3 | Unable to create security token. |
Error | 7 | The user is not in the crossAPI group. |
Authorization.CreateSecurityTokenPlugin
Creates a Security Token with a custom authentication plugin.
Parameters
Type | Name | Description | |
1 | string | UserName | The username. |
2 | string | Password | The password of the user. |
3 | string | PluginID | The GUID of the custom authentication plugin to use. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The security token. |
Error | 3 | Unable to create security token. |
Authorization.GetAllAuthMethods
Returns all the available authentication methods. The authentication methods are the custom authentication plugins.
Return Values
Result | Type/Value | Interpretation |
Success | string | The list of plugins available for authentication as XML. |
Returned XML (Example)
<?xmlversion="1.0"encoding="UTF-16"?><Plugins><PluginName="example_plugin"Id="71a6af2c-2621-4600-aef8-8994042d9c4c"Description="auth plugin example"/><PluginName="example_plugin"Id="257c8085-14b7-47eb-9aa6-85a3b4768a83"Description="auth plugin example"/></Plugins>
Authorization.GetUserGuidByST
Returns the GUID of the respective user according to the security token.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the user from which the security token has been created. |
Authorization.IsUserLoggedIn
Checks if the specified user is currently logged in.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserName | The username. |
Return Values
Result | Type/Value | Interpretation |
Success | int |
|
Error | 2 | User does not exist. |
Authorization.SetUserPassword
Sets the password for the specified user.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | Login | The users login, the username. |
3 | string | Password | The password of the user. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 2 | User does not exist. |
Error | 159 | Cannot change user password. |
Authorization.VerifyLicenseByLogin
Verifies that the license assigned to the specified user is active.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserName | The username. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 2 | User does not exist. |
Error | 168 | License does not exist or does not match the master license. |
Error | 179 | License disabled. |
Authorization.VerifyLoginData
Verifies the supplied login data.
Parameters
Type | Name | Description | |
1 | string | UserName | The username. |
2 | string | Password | The password of the user. |
Return Values
Result | Type/Value | Interpretation |
Success | int | 0 - OK |
Error | int | 1 - login or password is invalid |
Error | int | 5 - incorrect database version |
Error | int | -1 - unknown error |
Authorization.VerifyLoginData2
Verifies the supplied login data.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserName | The username. |
3 | string | Password | The password of the user. |
Return Values
Result | Type/Value | Interpretation |
Success | int | 0 - OK |
Error | int | 1 - login or password is invalid |
Error | int | 5 - incorrect database version |
Error | int | -1 - unknown error |
In addition to the checks of Authorization.VerifyLoginData, this function checks if the specified security token is valid.
Authorization.VerifyLoginData3
Verifies the supplied login data.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserName | The username. |
3 | string | Password | The password of the user. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the user. |
Error | 167 | Invalid username or password. |
This function does the same checks as Authorization.VerifyLoginData2, but returns the user GUID on success.
The return values from Authorization.VerifyLoginData2 that are not indicating success or invalid username or password are all mapped to error 142.
Authorization.VerifyLoginDataPlugin
Verifies the supplied login data with a custom authentication plugin.
Parameters
Type | Name | Description | |
1 | string | UserName | The username. |
2 | string | Password | The password of the user. |
3 | string | PluginID | The GUID of the custom authentication plugin to use. |
Return Values
Result | Type/Value | Interpretation |
Success | int | 0 - OK |
Error | int | 1 - login or password is invalid |
Error | int | 4 - plugin does not exist |
Error | int | -1 - unknown error |
Authorization.VerifyLoginDataPlugin2
Verifies the supplied login data with a custom authentication plugin.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserName | The username. |
3 | string | Password | The password of the user. |
4 | string | PluginID | The GUID of the custom authentication plugin to use. |
Return Values
Result | Type/Value | Interpretation |
Success | int | 0 - OK |
Error | int | 1 - login or password is invalid |
Error | int | 4 - plugin does not exist |
Error | int | -1 - unknown error |
Authorization.VerifyLoginDataPlugin3
Verifies the supplied login data with a custom authentication plugin.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserName | The username. |
3 | string | Password | The password of the user. |
4 | string | PluginID | The GUID of the custom authentication plugin to use. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the user. |
Error | 167 | Invalid username or password. |
Error | 169 | Plugin does not exist. |
This function does the same checks as Authorization.VerifyLoginDataPlugin2, but returns the user GUID on success.