Users¶
GET /api/1.1/users.json
Retrieves all users.
Authentication Required: Yes
Response Properties
Parameter Type Description string citystring idhash phoneNumberstring companystring countrystring fullNamestring localUserstring uidstring usernamestring rolenamestring newUserstring addressLine2string rolestring addressLine1string postalCodestring gidstring Response Example
[ { "email": "email@email.com", "city": "", "id": "54", "phoneNumber": "", "company": "", "country": "", "fullName": "Bob Simpson", "localUser": false, "uid": "0", "stateOrProvince": "", "username": "bsimpson", "rolename": "portal", "newUser": true, "addressLine2": "", "role": "6", "addressLine1": "", "postalCode": "", "gid": "0" } ]
GET /api/1.1/user/current.json
Retrieves the profile for the authenticated user.
Authentication Required: Yes
Request Properties
Parameter Type Description string citystring idstring phoneNumberstring companystring countrystring fullNamestring localUserboolean uidstring stateOrProvincestring usernamestring newUserboolean addressLine2string rolestring addressLine1string gidstring postalCodestring Response Example
{ “response”: { “email”: "email@email.com", “city”: "", “id”: "50", “phoneNumber”: "", “company”: "", “country”: "", “fullName”: "Tom Callahan", “localUser”: true, “uid”: "0", “stateOrProvince”: "", “username”: "tommyboy", “newUser”: false, “addressLine2”: "", “role”: "6", “addressLine1”: "", “gid”: "0", “postalCode”: "" }, “version”: "1.1" }
POST /api/1.1/user/current/update
Updates the date for the authenticated user.
Authentication Required: Yes
Request Properties
Parameter Type Description string citystring idstring phoneNumberstring companystring countrystring fullNamestring localUserboolean uidstring stateOrProvincestring usernamestring newUserboolean addressLine2string rolestring addressLine1string gidstring postalCodestring Request Example
{ "user": { "email": "", "city": "", "id": "", "phoneNumber": "", "company": "", "country": "", "fullName": "", "localUser": true, "uid": "0", "stateOrProvince": "", "username": "tommyboy", "newUser": false, "addressLine2": "", "role": "6", "addressLine1": "", "gid": "0", "postalCode": "" } }Response Properties
Parameter Type Description alertsarray A collection of alert messages. >levelstring Success, info, warning or error. >textstring Alert message. versionstring Response Example
{ "alerts": [ { "level": "success", "text": "UserProfile was successfully updated." } ], "version": "1.1" }
GET /api/1.1/user/current/jobs.json
Retrieves user purge jobs.
Authentication Required: Yes
Response Properties
Parameter Type Description keywordstring objectNamestring assetUrlstring assetTypestring statusstring dsIdstring dsXmlIdstring usernameboolean parametersstring enteredTimestring objectTypestring agentstring idstring startTimestring versionstring Response Example
{ "response": [ { "id": "1", "keyword": "PURGE", "objectName": null, "assetUrl": "", "assetType": "file", "status": "PENDING", "dsId": "73", "dsXmlId": "cim-jitp", "username": "peewee", "parameters": "TTL:56h", "enteredTime": "2015-01-21 18:00:16", "objectType": null, "agent": "", "startTime": "2015-01-21 10:45:38" } ], "version": "1.1" }
POST/api/1.1/user/current/jobs
Creates a purge job.
Authentication Required: Yes
Request Properties
Parameter Type Description dsIdstring dsXmlIdstring regexstring startTimestring ttlint Request Example
{ "dsId": "73", "dsXmlId": "cim-jitp", "regex": "/path/to/content.jpg", "startTime": "2015-01-27 11:08:37", "ttl": 54 }Response Content Type: application/json
Response Properties
Parameter Type Description alertsarray A collection of alert messages. >levelstring Success, info, warning or error. >textstring Alert message. versionstring Response Example
{ “alerts”: [ { “level”: "success", “text”: "Successfully created purge job for: ." } ], “version”: "1.1" }
POST /api/1.1/user/login { u: ‘’, p: ‘’ }
Authentication of a user using username and password. Traffic Ops will send back a session cookie.
Authentication Required: No
Request Properties
Parameter Type Description ustring username pstring password Request Example
{ "u": "username", "p": "password" }Response Content Type: application/json
Response Properties
Parameter Type Description alertsarray A collection of alert messages. >levelstring Success, info, warning or error. >textstring Alert message. versionstring Response Example
{ "alerts": [ { "level": "success", "text": "Successfully logged in." } ], "version": "1.1" }
GET /api/1.1/user/:id/deliveryservices/available.json
Authentication Required: Yes
Request Route Parameters
Name Required Description id yes Response Properties
Parameter Type Description xmlIdstring idstring Response Example
{ "response": [ { "xmlId": "ns-img", "id": "90" }, { "xmlId": "ns-img-secure", "id": "280" } ], "version": "1.1" }
POST /api/1.1/user/login/token
Authentication of a user using a token.
Authentication Required: No
Request Route Properties
Parameter Type Description tstring token-value Request Example
{ "t": "token-value" }Response Content Type: application/json
Response Properties
Parameter Type Description alertsarray >levelstring >textstring versionstring Response Example
{ "alerts": [ { "level": "error", "text": "Unauthorized, please log in." } ], "version": "1.1" }
POST /api/1.1/user/logout
User logout. Invalidates the session cookie.
Authentication Required: Yes
Response Properties
Parameter Type Description alertsarray
levelstring
textstring versionstring Response Example
{ "alerts": [ { "level": "success", "text": "You are logged out." } ], "version": "1.1" }
POST /api/1.1/user/reset_password
Reset user password.
Authentication Required: No
Request Properties
Parameter Type Description string The email address of the user to initiate password reset. Request Example
{ "email": "email@email.com" }Response Properties
Parameter Type Description alertsarray A collection of alert messages.
levelstring Success, info, warning or error.
textstring Alert message. versionstring Response Example
{ "alerts": [ { "level": "success", "text": "Successfully logged in." } ], "version": "1.1" }