C# Class OneAndOne.Client.Endpoints.Users.UserAPI

Inheritance: ResourceBase

Datei anzeigen Open project: 1and1/oneandone-cloudserver-sdk-dotnet

Public Methods

Method	Description
DeleteUserIp ( string user_id, string ip ) : UserResponse	Deletes an IP and forbides API access for it.
GetUserIps ( string user_id ) : List	IP's from which access to API is allowed.
ShowUserAPI ( string user_id ) : ApiResponse	Information about API.
ShowUserAPIKey ( string user_id ) : UserAPIKeyResponse	Shows the API key
UpdateAPIIps ( List ips, string user_id ) : UserResponse	Allows a new IP
UpdateAPIKey ( string user_id ) : UserResponse	Changes the API key
UpdateUserAPI ( string user_id, bool active ) : UserResponse	Allows to enable or disable the API.
UserAPI ( object _apiUrl = null, object _apiKey = null ) : System

Method Details

DeleteUserIp() public method

Deletes an IP and forbides API access for it.

public DeleteUserIp ( string user_id, string ip ) : UserResponse
user_id	string	Unique user's identifier.
ip	string	Desired IP
return	OneAndOne.POCO.Respones.Users.UserResponse

GetUserIps() public method

IP's from which access to API is allowed.

public GetUserIps ( string user_id ) : List
user_id	string
return	List

ShowUserAPI() public method

Information about API.

public ShowUserAPI ( string user_id ) : ApiResponse
user_id	string
return	OneAndOne.POCO.Respones.Users.ApiResponse

ShowUserAPIKey() public method

Shows the API key

public ShowUserAPIKey ( string user_id ) : UserAPIKeyResponse
user_id	string
return	OneAndOne.POCO.Respones.Users.UserAPIKeyResponse

UpdateAPIIps() public method

Allows a new IP

public UpdateAPIIps ( List ips, string user_id ) : UserResponse
ips	List
user_id	string	Unique user's identifier.
return	OneAndOne.POCO.Respones.Users.UserResponse

UpdateAPIKey() public method

Changes the API key

public UpdateAPIKey ( string user_id ) : UserResponse
user_id	string	Unique user's identifier.
return	OneAndOne.POCO.Respones.Users.UserResponse

UpdateUserAPI() public method

Allows to enable or disable the API.

public UpdateUserAPI ( string user_id, bool active ) : UserResponse
user_id	string	Unique user's identifier.
active	bool
return	OneAndOne.POCO.Respones.Users.UserResponse

UserAPI() public method

public UserAPI ( object _apiUrl = null, object _apiKey = null ) : System
_apiUrl	object
_apiKey	object
return	System