- Home
- API reference
- API documentation (JSON/XML)
- Tasks
- AuthSession tasks
AuthSession create
Function
With the AuthSessionCreate task, you create a sessionID that you can use for various actions.
Description
For JSON requests, the SessionID is returned in the header.
X-Domainrobot-SessionId: b3a9489e-e40e-41e2-a3eb-01a26f2aba3b
Query parameters
If the login is successful, the system returns the user data in the reply. Depending on the selected query parameters, additional user data is output.
Parameter | Description | Type | Required |
|---|---|---|---|
| acl | Specifies whether the ACLs of the user should be output in the response. | boolean | optional |
| customer | Specifies whether the customer data should be output in the reply. | boolean | optional |
| profile | Specifies whether the profile data should be output in the response. | boolean | optional |
| timeout | Specifies the session duration in minutes (minimum 10 minutes - maximum 300 minutes). Default: 10 minutes | integer | optional |
POST /login?acl=true&profile=true&customer=true&timeout=60
{
"context": "4",
"user": "customer",
"password": "password"
}Response for parameter values "false"
{
"status": {
"code": "S1321001",
"text": "Session token has been created successfully.",
"type": "SUCCESS"
},
"stid": "20180915-app1",
"object": {
"type": "user",
"value": "customer, 4"
},
"data": [
{
"user": "customer",
"context": 4,
"defaultEmail": "customer@example.com",
"status": 2,
"substatus": 0,
"owner": {},
"language": "en"
}
]
}Response for parameter values "true"
{
"status": {
"code": "S1321001",
"text": "S1321001",
"type": "SUCCESS"
},
"object": {
"type": "User",
"value": "customer, 4"
},
"data": [
{
"context": 4,
"defaultEmail": "customer@example.com",
"status": 2,
"substatus": 2,
"authType": "PASSWORD",
"lock": "NONE",
"profiles": {
"profiles": [
{
"key": "message_format",
"value": "CUSTOM",
"flag": "RECURSE",
"readonly": false
},
{
"key": "authinfo_from",
"value": "DOMAIN ROBOT",
"flag": "RECURSE",
"readonly": false
},
{
"key": "test",
"value": "test",
"flag": "FIX",
"readonly": true
},
{
"key": "irtp_foa1_supportmail",
"value": "do-not-reply@domain-robot.org",
"flag": "RECURSE",
"readonly": false
},
{
"key": "ssl_trusted_application_password",
"value": "BEsQHqD2F4YaZLBRLgvW_6ac0e672f29428a43d791e3947d65e4bf4bed0bad",
"flag": "OPTIONAL",
"readonly": false
},
{
"key": "irtp_foa2_from",
"value": "Domain Transfer / Domain Robot",
"flag": "RECURSE",
"readonly": false
},
{
"key": "customer_fix",
"value": "4",
"flag": "FIX",
"readonly": true
},
{
"key": "authinfo_supportmail",
"value": "do-not-reply@domain-robot.org",
"flag": "RECURSE",
"readonly": false
},
{
"key": "ssl_trusted_application_uuid",
"value": "666dd494-83fe-4a31-9ed1-a8fc4e7594eb",
"flag": "OPTIONAL",
"readonly": false
},
{
"key": "message_channel",
"value": "EMAIL",
"flag": "RECURSE",
"readonly": false
},
{
"key": "ssl_techc",
"value": "",
"flag": "OPTIONAL",
"readonly": false
},
{
"key": "irtp_foa1_reminder",
"value": "yes",
"flag": "RECURSE",
"readonly": false
},
{
"key": "irtp_foa2_to",
"value": "admin",
"flag": "RECURSE",
"readonly": false
},
{
"key": "irtp_foa1_to",
"value": "both",
"flag": "RECURSE",
"readonly": false
},
{
"key": "ssl_software",
"value": "",
"flag": "OPTIONAL",
"readonly": false
},
{
"key": "irtp_foa2_supportmail",
"value": "do-not-reply@domain-robot.org",
"flag": "RECURSE",
"readonly": false
},
{
"key": "irtp_foa1_from",
"value": "Domain Transfer / Domain Robot",
"flag": "RECURSE",
"readonly": false
},
{
"key": "irtp_foa1_ignore",
"value": "yes",
"flag": "RECURSE",
"readonly": false
},
{
"key": "domain_ownerc",
"value": "",
"flag": "OPTIONAL",
"readonly": false
}
]
},
"customer": {
"number": 123456,
"client": "ix",
"name": "",
"country": "DE",
"payment": "POST",
"taxable": false,
"autodelete": true
},
"user": "customer",
"language": "de",
"parent": {
"context": 1,
"status": 1,
"substatus": 2,
"lock": "NONE",
"user": "parentname"
},
"directCustomer": true
}
]
}For XML requests the SessionID is returned in the tag <hash>.
<hash>9b4b36ff-2bed-41c8-8471-6ede5d2873dd</hash>
Task code: 1321001
Uses User object
<request>
<auth>
<user>customer</user>
<password>test</password>
<context>4</context>
</auth>
<task>
<code>1321001</code>
</task>
</request><response>
<result>
<data>
<auth_session>
<user>
<user>customer</user>
<context>1</context>
</user>
<hash>9b4b36ff-2bed-41c8-8471-6ede5d2873dd</hash>
<ip>192.168.0.254</ip>
<user_agent></user_agent>
<timeout>10</timeout>
<language>de</language>
<valid_until>2015-12-09 15:03:33</valid_until>
<owner>
<user>customer</user>
<context>4</context>
</owner>
<updater>
<user>customer</user>
<context>4</context>
</updater>
<id>17</id>
<created>2015-12-09 14:53:33</created>
<updated>2015-12-09 14:53:33</updated>
</auth_session>
</data>
<status>
<code>S1321001</code>
<type>success</type>
<object>
<type>user</type>
<value>customer, 4</value>
</object>
</status>
</result>
</response>