Login Credential API

From TeamServer ER/Studio
Jump to: navigation, search

Go Up to API Reference

This part of the Team Server API lets you work with login credentials.

GET v1/logincredentials

Obtains a list of login credentials.

If successful, the response from the server provides a list of login credentials with details about each one of them.

GET v1/datasources/<datasource_id>/logincredentials

Obtains a list of login credentials related to the data source with the specified ID. See Data Source API.

If successful, the response from the server provides a list of login credentials with details about each one of them.

GET v1/logincredentials/<id>

Obtains information about the login credential with the specified ID.

POST v1/logincredentials

Creates a login credential. Your request must provide the following fields:

  • name
  • username
  • password

If successful, the response from the server provides all the details about your new login credential.

PUT v1/logincredentials/<id>

Updates the information of a login credential. Your request can provide any combination of the fields. Just ID is requiered.

If successful, the response from the server provides all the details about your modified login credential.

DELETE v1/logincredentials/<id>

Deletes the login credential with the specified ID. If successful, the response is {"message":"OK","status":"200"}.

Login Credential Fields

Login Credential resources in Login Credential API requests and responses can include any combination of the following fields:

Item Example Description

"id"

16

An integer that uniquely identifies the login credential.

"status"

"In progress"

A string that defines the status of the login credential using nomenclature you decide upon.

"description"

"Admin user"

A description of the login credential.

"username"

"Administrator"

The username account to log into the datasource.

"trusted"

true

trusted or not.

"name"

"Administrator"

The name of the login credential.

"trustedHost"

"esvmhostname."

Name of the trusted host.

"role"

"Admin"

The role of the username.

"aliases"

"alias"

A list of aliases and synonyms of the login credential.

"abbreviations"

"Ad"

A list of abbreviations of the login credential.

"createdAt"

1372150068

The date when the group was created, in Unix time (seconds since 1970).

"modifiedAt"

1372150068

The date when the group was modifiet, in Unix time (seconds since 1970).

Example Response

This is an example response from a GET v1/logincredentials call:

{

    "logincredentials" : {

        "id" : 123,

        "name" : "Login Credentials Name",

        "type" : "Login Credentials",

        "url" : "http://api.connect.example.com/v1/logincredentials/123",

        "link" : "http://connect.example.com/identityobject/view.spg?key=123",

        "createdAt" : 1320296464,

        "modifiedAt" : 1320296466,

        "description" : "Database information.",

        "abbreviations" : "LC",

        "aliases" : "Earnings",

        "userData" : "some text",

        "status" : "Online",

    }

}

See Also

Personal tools
Product Videos