source/api-docs/master/credential_store_data_models.html - airavata-site - Git at Google

 <!DOCTYPE html>
 <html lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 <link href="style.css" rel="stylesheet" type="text/css"/>
 <title>Thrift module: credential_store_data_models</title></head><body>
 <div class="container-fluid">
 <h1>Thrift module: credential_store_data_models</h1>
 <table class="table-bordered table-striped table-condensed"><thead><tr><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></tr></thead><tbody>
 <tr>
 <td>credential_store_data_models</td><td></td>
 <td><a href="#Struct_CertificateCredential">CertificateCredential</a><br/>
 <a href="#Struct_CommunityUser">CommunityUser</a><br/>
 <a href="#Struct_CredentialSummary">CredentialSummary</a><br/>
 <a href="#Struct_PasswordCredential">PasswordCredential</a><br/>
 <a href="#Struct_SSHCredential">SSHCredential</a><br/>
 <a href="#Enum_SummaryType">SummaryType</a><br/>
 </td>
 <td><code><a href="#Const_DEFAULT_ID">DEFAULT_ID</a></code><br/>
 </td>
 </tr></tbody></table>
 <hr/><h2 id="Constants">Constants</h2>
 <table class="table-bordered table-striped table-condensed"><thead><tr><th>Constant</th><th>Type</th><th>Value</th></tr></thead><tbody>
 <tr id="Const_DEFAULT_ID"><td><code>DEFAULT_ID</code></td><td><code>string</code></td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr></tbody></table><hr/><h2 id="Enumerations">Enumerations</h2>
 <div class="definition"><h3 id="Enum_SummaryType">Enumeration: SummaryType</h3>
 <pre>Data Types supported in Airavata. The primitive data types

 </pre><br/><br/><table class="table-bordered table-striped table-condensed">
 <tr><td><code>SSH</code></td><td><code>0</code></td><td>
 </td></tr>
 <tr><td><code>PASSWD</code></td><td><code>1</code></td><td>
 </td></tr>
 <tr><td><code>CERT</code></td><td><code>2</code></td><td>
 </td></tr>
 </table></div>
 <hr/><h2 id="Structs">Data structures</h2>
 <div class="definition"><h3 id="Struct_SSHCredential">Struct: SSHCredential</h3>
 <table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
 <tr><td>1</td><td>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
 <tr><td>2</td><td>username</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
 <tr><td>3</td><td>passphrase</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
 <tr><td>4</td><td>publicKey</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
 <tr><td>5</td><td>privateKey</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
 <tr><td>6</td><td>persistedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
 <tr><td>7</td><td>token</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
 <tr><td>8</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
 </tbody></table><br/></div><div class="definition"><h3 id="Struct_CredentialSummary">Struct: CredentialSummary</h3>
 <table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
 <tr><td>1</td><td>type</td><td><code><a href="#Enum_SummaryType">SummaryType</a></code></td><td></td><td>required</td><td></td></tr>
 <tr><td>2</td><td>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
 <tr><td>3</td><td>username</td><td><code>string</code></td><td>The username corresponds to the Credential's `portalUserName` which is the username of the user that
 created the credential.
 </td><td>required</td><td></td></tr>
 <tr><td>4</td><td>publicKey</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
 <tr><td>5</td><td>persistedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
 <tr><td>6</td><td>token</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
 <tr><td>7</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
 </tbody></table><br/></div><div class="definition"><h3 id="Struct_CommunityUser">Struct: CommunityUser</h3>
 <table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
 <tr><td>1</td><td>gatewayName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
 <tr><td>2</td><td>username</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
 <tr><td>3</td><td>userEmail</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
 </tbody></table><br/></div><div class="definition"><h3 id="Struct_CertificateCredential">Struct: CertificateCredential</h3>
 <table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
 <tr><td>1</td><td>communityUser</td><td><code><a href="#Struct_CommunityUser">CommunityUser</a></code></td><td></td><td>required</td><td></td></tr>
 <tr><td>2</td><td>x509Cert</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
 <tr><td>3</td><td>notAfter</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
 <tr><td>4</td><td>privateKey</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
 <tr><td>5</td><td>lifeTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
 <tr><td>6</td><td>notBefore</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
 <tr><td>7</td><td>persistedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
 <tr><td>8</td><td>token</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
 </tbody></table><br/></div><div class="definition"><h3 id="Struct_PasswordCredential">Struct: PasswordCredential</h3>
 <table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
 <tr><td>1</td><td>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
 <tr><td>2</td><td>portalUserName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
 <tr><td>3</td><td>loginUserName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
 <tr><td>4</td><td>password</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
 <tr><td>5</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
 <tr><td>6</td><td>persistedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
 <tr><td>7</td><td>token</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
 </tbody></table><br/></div></div></body></html>
	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
	<link href="style.css" rel="stylesheet" type="text/css"/>
	<title>Thrift module: credential_store_data_models</title></head><body>
	<div class="container-fluid">
	<h1>Thrift module: credential_store_data_models</h1>
	<table class="table-bordered table-striped table-condensed"><thead><tr><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></tr></thead><tbody>
	<tr>
	<td>credential_store_data_models</td><td></td>
	<td><a href="#Struct_CertificateCredential">CertificateCredential</a><br/>
	<a href="#Struct_CommunityUser">CommunityUser</a><br/>
	<a href="#Struct_CredentialSummary">CredentialSummary</a><br/>
	<a href="#Struct_PasswordCredential">PasswordCredential</a><br/>
	<a href="#Struct_SSHCredential">SSHCredential</a><br/>
	<a href="#Enum_SummaryType">SummaryType</a><br/>
	</td>
	<td><code><a href="#Const_DEFAULT_ID">DEFAULT_ID</a></code><br/>
	</td>
	</tr></tbody></table>
	<hr/><h2 id="Constants">Constants</h2>
	<table class="table-bordered table-striped table-condensed"><thead><tr><th>Constant</th><th>Type</th><th>Value</th></tr></thead><tbody>
	<tr id="Const_DEFAULT_ID"><td><code>DEFAULT_ID</code></td><td><code>string</code></td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr></tbody></table><hr/><h2 id="Enumerations">Enumerations</h2>
	<div class="definition"><h3 id="Enum_SummaryType">Enumeration: SummaryType</h3>
	<pre>Data Types supported in Airavata. The primitive data types

	</pre><br/><br/><table class="table-bordered table-striped table-condensed">
	<tr><td><code>SSH</code></td><td><code>0</code></td><td>
	</td></tr>
	<tr><td><code>PASSWD</code></td><td><code>1</code></td><td>
	</td></tr>
	<tr><td><code>CERT</code></td><td><code>2</code></td><td>
	</td></tr>
	</table></div>
	<hr/><h2 id="Structs">Data structures</h2>
	<div class="definition"><h3 id="Struct_SSHCredential">Struct: SSHCredential</h3>
	<table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
	<tr><td>1</td><td>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
	<tr><td>2</td><td>username</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
	<tr><td>3</td><td>passphrase</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
	<tr><td>4</td><td>publicKey</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
	<tr><td>5</td><td>privateKey</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
	<tr><td>6</td><td>persistedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
	<tr><td>7</td><td>token</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
	<tr><td>8</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
	</tbody></table><br/></div><div class="definition"><h3 id="Struct_CredentialSummary">Struct: CredentialSummary</h3>
	<table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
	<tr><td>1</td><td>type</td><td><code><a href="#Enum_SummaryType">SummaryType</a></code></td><td></td><td>required</td><td></td></tr>
	<tr><td>2</td><td>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
	<tr><td>3</td><td>username</td><td><code>string</code></td><td>The username corresponds to the Credential's `portalUserName` which is the username of the user that
	created the credential.
	</td><td>required</td><td></td></tr>
	<tr><td>4</td><td>publicKey</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
	<tr><td>5</td><td>persistedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
	<tr><td>6</td><td>token</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
	<tr><td>7</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
	</tbody></table><br/></div><div class="definition"><h3 id="Struct_CommunityUser">Struct: CommunityUser</h3>
	<table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
	<tr><td>1</td><td>gatewayName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
	<tr><td>2</td><td>username</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
	<tr><td>3</td><td>userEmail</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
	</tbody></table><br/></div><div class="definition"><h3 id="Struct_CertificateCredential">Struct: CertificateCredential</h3>
	<table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
	<tr><td>1</td><td>communityUser</td><td><code><a href="#Struct_CommunityUser">CommunityUser</a></code></td><td></td><td>required</td><td></td></tr>
	<tr><td>2</td><td>x509Cert</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
	<tr><td>3</td><td>notAfter</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
	<tr><td>4</td><td>privateKey</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
	<tr><td>5</td><td>lifeTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
	<tr><td>6</td><td>notBefore</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
	<tr><td>7</td><td>persistedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
	<tr><td>8</td><td>token</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
	</tbody></table><br/></div><div class="definition"><h3 id="Struct_PasswordCredential">Struct: PasswordCredential</h3>
	<table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
	<tr><td>1</td><td>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
	<tr><td>2</td><td>portalUserName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
	<tr><td>3</td><td>loginUserName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
	<tr><td>4</td><td>password</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
	<tr><td>5</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
	<tr><td>6</td><td>persistedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
	<tr><td>7</td><td>token</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
	</tbody></table><br/></div></div></body></html>