AuthTokenControllerApi

All URIs are relative to https://SSC:8080/ssc/api/v1

Method	HTTP request	Description
createAuthToken	POST /tokens	create
deleteAuthToken	DELETE /tokens/{id}	delete
listAuthToken	GET /tokens	list
multiDeleteAuthToken	DELETE /tokens	Revoke authentication tokens using ONE of two choices: (1) all tokens owned by the requesting user, OR (2) list of token ids.
revokeAuthToken	POST /tokens/action/revoke	Revoke authentication tokens by value
updateAuthToken	PUT /tokens/{id}	update

createAuthToken

ApiResultAuthenticationToken createAuthToken(authToken)

create

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.AuthTokenControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: Basic
HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
Basic.setUsername("YOUR USERNAME");
Basic.setPassword("YOUR PASSWORD");

AuthTokenControllerApi apiInstance = new AuthTokenControllerApi();
AuthenticationToken authToken = new AuthenticationToken(); // AuthenticationToken | authToken
try {
    ApiResultAuthenticationToken result = apiInstance.createAuthToken(authToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthTokenControllerApi#createAuthToken");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authToken	AuthenticationToken	authToken

Return type

ApiResultAuthenticationToken

Authorization

Basic

HTTP request headers

Content-Type: application/json
Accept: application/json

deleteAuthToken

ApiResultVoid deleteAuthToken(id)

delete

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.AuthTokenControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: Basic
HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
Basic.setUsername("YOUR USERNAME");
Basic.setPassword("YOUR PASSWORD");

AuthTokenControllerApi apiInstance = new AuthTokenControllerApi();
Long id = 789L; // Long | id
try {
    ApiResultVoid result = apiInstance.deleteAuthToken(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthTokenControllerApi#deleteAuthToken");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Long	id

Return type

ApiResultVoid

Authorization

Basic

HTTP request headers

Content-Type: application/json
Accept: application/json

listAuthToken

ApiResultListAuthenticationToken listAuthToken(fields, start, limit, q, orderby)

list

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.AuthTokenControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: Basic
HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
Basic.setUsername("YOUR USERNAME");
Basic.setPassword("YOUR PASSWORD");

AuthTokenControllerApi apiInstance = new AuthTokenControllerApi();
String fields = "fields_example"; // String | Output fields
Integer start = 0; // Integer | A start offset in object listing
Integer limit = 200; // Integer | A maximum number of returned objects in listing, if '-1' or '0' no limit is applied
String q = "q_example"; // String | A search query
String orderby = "orderby_example"; // String | Fields to order by
try {
    ApiResultListAuthenticationToken result = apiInstance.listAuthToken(fields, start, limit, q, orderby);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthTokenControllerApi#listAuthToken");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
fields	String	Output fields	[optional]
start	Integer	A start offset in object listing	[optional] [default to 0]
limit	Integer	A maximum number of returned objects in listing, if '-1' or '0' no limit is applied	[optional] [default to 200]
q	String	A search query	[optional]
orderby	String	Fields to order by	[optional]

Return type

ApiResultListAuthenticationToken

Authorization

Basic

HTTP request headers

Content-Type: application/json
Accept: application/json

multiDeleteAuthToken

ApiResultVoid multiDeleteAuthToken(all, ids)

Revoke authentication tokens using ONE of two choices: (1) all tokens owned by the requesting user, OR (2) list of token ids.

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.AuthTokenControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: Basic
HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
Basic.setUsername("YOUR USERNAME");
Basic.setPassword("YOUR PASSWORD");

AuthTokenControllerApi apiInstance = new AuthTokenControllerApi();
Boolean all = false; // Boolean | Specify value 'true' to revoke all authentication tokens of current logged-in user. This parameter can only be used if the 'ids' parameter is not being used.
String ids = "ids_example"; // String | A comma-separated list of resource identifiers
try {
    ApiResultVoid result = apiInstance.multiDeleteAuthToken(all, ids);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthTokenControllerApi#multiDeleteAuthToken");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
all	Boolean	Specify value 'true' to revoke all authentication tokens of current logged-in user. This parameter can only be used if the 'ids' parameter is not being used.	[optional] [default to false]
ids	String	A comma-separated list of resource identifiers	[optional]

Return type

ApiResultVoid

Authorization

Basic

HTTP request headers

Content-Type: application/json
Accept: application/json

revokeAuthToken

ApiResultVoid revokeAuthToken(resource)

Revoke authentication tokens by value

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.AuthTokenControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: Basic
HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
Basic.setUsername("YOUR USERNAME");
Basic.setPassword("YOUR PASSWORD");

AuthTokenControllerApi apiInstance = new AuthTokenControllerApi();
AuthTokenRevokeRequest resource = new AuthTokenRevokeRequest(); // AuthTokenRevokeRequest | resource
try {
    ApiResultVoid result = apiInstance.revokeAuthToken(resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthTokenControllerApi#revokeAuthToken");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
resource	AuthTokenRevokeRequest	resource

Return type

ApiResultVoid

Authorization

Basic

HTTP request headers

Content-Type: application/json
Accept: application/json

updateAuthToken

ApiResultAuthenticationToken updateAuthToken(id, resource)

update

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.AuthTokenControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: Basic
HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
Basic.setUsername("YOUR USERNAME");
Basic.setPassword("YOUR PASSWORD");

AuthTokenControllerApi apiInstance = new AuthTokenControllerApi();
Long id = 789L; // Long | id
AuthenticationToken resource = new AuthenticationToken(); // AuthenticationToken | resource
try {
    ApiResultAuthenticationToken result = apiInstance.updateAuthToken(id, resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthTokenControllerApi#updateAuthToken");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Long	id
resource	AuthenticationToken	resource

Return type

ApiResultAuthenticationToken

Authorization

Basic

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

AuthTokenControllerApi.md

Latest commit

History

AuthTokenControllerApi.md

File metadata and controls

AuthTokenControllerApi

createAuthToken

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAuthToken

Example

Parameters

Return type

Authorization

HTTP request headers

listAuthToken

Example

Parameters

Return type

Authorization

HTTP request headers

multiDeleteAuthToken

Example

Parameters

Return type

Authorization

HTTP request headers

revokeAuthToken

Example

Parameters

Return type

Authorization

HTTP request headers

updateAuthToken

Example

Parameters

Return type

Authorization

HTTP request headers