Class AdminApi

java.lang.Object

nl.bimbase.bimworks.client.apis.SubApi

nl.bimbase.bimworks.client.apis.AdminApi

public class AdminApi
extends SubApi

Administrator API calls, generally require elevated privileges

Constructor Summary

Constructors

Constructor	Description
AdminApi(BimWorksClient bimWorksClient)

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.node.ObjectNode	createApiToken(UUID nodeUuid, String name, EnumSet<Scope> scopes, LocalDate expiresOn)	Create an API token restricted to the given scopes (the preferred variant — see Scope).
String	createApiToken(UUID nodeUuid, String name, Set<String> allowedCorsDomains, Set<String> whiteListedIpAddresses, Set<ApiTokenCredential> credentials)
String	createApiToken(UUID nodeUuid, String name, Set<String> allowedCorsDomains, Set<String> whiteListedIpAddresses, Set<ApiTokenCredential> credentials, LocalDate expiresOn)
void	deleteApiToken(UUID uuid)
com.fasterxml.jackson.databind.JsonNode	listAccounts()	Accounts visible to the caller (its organization; every organization for a super admin).
com.fasterxml.jackson.databind.node.ArrayNode	listAccountUserFeatures(UUID accountUuid)	Every user feature with its enabled flag for the account (own account, or super admin).
com.fasterxml.jackson.databind.node.ArrayNode	listFolderApiTokens(UUID nodeUuid)	API tokens rooted at the given folder (secret redacted).
com.fasterxml.jackson.databind.JsonNode	listOrganizations()
String	rotateApiTokenSecret(UUID uuid)	Replace the secret of an API token; the old secret stops working immediately.
void	setUserFeature(UUID accountUuid, String feature, boolean enabled)	Super admin only: switch a user feature for an account.
void	updateApiToken(UUID uuid, String name, EnumSet<Scope> scopes, LocalDate expiresOn)	Update name, scopes and/or expiry of an API token; null leaves a property unchanged.

Methods inherited from class SubApi

getBimWorksClient

Modifier and Type	Method	Description
BimWorksClient	getBimWorksClient()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AdminApi

public AdminApi(BimWorksClient bimWorksClient)

Method Details

createApiToken

public String createApiToken(UUID nodeUuid,
 String name,
 Set<String> allowedCorsDomains,
 Set<String> whiteListedIpAddresses,
 Set<ApiTokenCredential> credentials)
                      throws nl.sascom.backplane.common.ExecuteException,
InterruptedException,
BimWorksException

Throws:

nl.sascom.backplane.common.ExecuteException

InterruptedException

BimWorksException

createApiToken

public String createApiToken(UUID nodeUuid,
 String name,
 Set<String> allowedCorsDomains,
 Set<String> whiteListedIpAddresses,
 Set<ApiTokenCredential> credentials,
 LocalDate expiresOn)
                      throws nl.sascom.backplane.common.ExecuteException,
InterruptedException,
BimWorksException

Parameters:

expiresOn - the day the token stops working (usable through the whole of that UTC day); null for the server's default (one month ahead). The server refuses a date further ahead than its configured maximum (three years).

Throws:

nl.sascom.backplane.common.ExecuteException

InterruptedException

BimWorksException

createApiToken

public com.fasterxml.jackson.databind.node.ObjectNode createApiToken(UUID nodeUuid,
 String name,
 EnumSet<Scope> scopes,
 LocalDate expiresOn)
                                                              throws BimWorksException

Create an API token restricted to the given scopes (the preferred variant — see Scope). The token value is returned once and never again.

Returns:

{token, expires_on}

Throws:

BimWorksException

listFolderApiTokens

public com.fasterxml.jackson.databind.node.ArrayNode listFolderApiTokens(UUID nodeUuid)
                                                                  throws BimWorksException

API tokens rooted at the given folder (secret redacted).

Throws:

BimWorksException

updateApiToken

public void updateApiToken(UUID uuid,
 String name,
 EnumSet<Scope> scopes,
 LocalDate expiresOn)
                    throws BimWorksException

Update name, scopes and/or expiry of an API token; null leaves a property unchanged.

Throws:

BimWorksException

rotateApiTokenSecret

public String rotateApiTokenSecret(UUID uuid)
                            throws BimWorksException

Replace the secret of an API token; the old secret stops working immediately. @return the new token value

Throws:

BimWorksException

deleteApiToken

public void deleteApiToken(UUID uuid)
                    throws BimWorksException

Throws:

BimWorksException

listAccounts

public com.fasterxml.jackson.databind.JsonNode listAccounts()
                                                     throws BimWorksException

Accounts visible to the caller (its organization; every organization for a super admin).

Throws:

BimWorksException

listOrganizations

public com.fasterxml.jackson.databind.JsonNode listOrganizations()
                                                          throws BimWorksException

Throws:

BimWorksException

listAccountUserFeatures

public com.fasterxml.jackson.databind.node.ArrayNode listAccountUserFeatures(UUID accountUuid)
                                                                      throws BimWorksException

Every user feature with its enabled flag for the account (own account, or super admin).

Throws:

BimWorksException

setUserFeature

public void setUserFeature(UUID accountUuid,
 String feature,
 boolean enabled)
                    throws BimWorksException

Super admin only: switch a user feature for an account.

Throws:

BimWorksException