Create an API Key using the Workload Security console

    <p>Create an API key to use for authenticating your requests with Workload Security. Trend Micro recommends creating one API key for every user needing API access to the Workload Security.</p>
    <p>Upon creation of an API key, you are provided a unique secret key that is associated with the API key. You use this secret key with your API calls for authenticating. You must store the secret key when it is provided because at no other time are you able to obtain it. If you lose the secret key you must create a new API key or create a new secret key for the API key.</p>
    <div class="note">An account with administrator privileges is required to create an API key.</div>
    <p>To create a new API key:</p>
    <ol>
        <li>Go to <span class="ui">Administration &gt; User Management &gt; API Keys</span>.</li>
        <li>Click <span class="ui">New</span>.</li>
        <li>In the Properties window, enter a <span class="ui">Name</span> and <span class="ui">Description</span> for the API key.</li>
        <li>Click on the <span class="ui">Role</span> list and select a role. <span class="ui">Auditor</span> grants read-only access to the Workload Security through the API, while <span class="ui">Full Access</span> grants both read and write access. If you need more specific roles for API key users, you can select <span class="ui">New</span> and define one. See <a href="../user-roles">Define roles for users</a> for more information on doing so.</li>
        <li>Select a <span class="ui">Language</span>.</li>
        <li>Select a <span class="ui">Time Zone</span> to associate with the key. This is the default time zone used for interpreting date and time values in API calls and responses.</li>
        <li>Optionally select <span class="ui">Expires on</span> and select a date to limit access to a specific period of time.</li>
        <li>Click <span class="ui">OK</span>.</li>
        <li>
            <p>Copy the <span class="ui">Secret key value</span>.</p>
            <p class="note">Make sure to copy the secret key value now, this is the only time it will be shown.</p>
        </li>
    </ol>
    <h2>Lock out an existing API key</h2>
    <p>If an existing API key has been compromised you can lock it out:</p>
    <ol>
        <li>Double click on the API key you want to lock out.</li>
        <li>Optionally select <span class="ui">Locked Out (Denied permission to authenticate)</span> to block usage of the API key.</li>
        <li>Click <span class="ui">OK</span>.</li>
    </ol>
</body>