Documentation

AuthApi
in package

BIMworks

AuthApi Class Doc Comment

Constants

contentTypes : array<string|int, string> = ['createAnonymousToken' => ['application/json']...

Properties

$client : ClientInterface
$config : Configuration
$headerSelector : HeaderSelector
$hostIndex : int

Methods

__construct() : mixed
createAnonymousToken() : CreateAnonymousTokenResult|ErrorResponse: Operation createAnonymousToken
createAnonymousTokenAsync() : PromiseInterface: Operation createAnonymousTokenAsync
createAnonymousTokenAsyncWithHttpInfo() : PromiseInterface: Operation createAnonymousTokenAsyncWithHttpInfo
createAnonymousTokenRequest() : Request: Create request for operation 'createAnonymousToken'
createAnonymousTokenWithHttpInfo() : array<string|int, mixed>: Operation createAnonymousTokenWithHttpInfo
createApiToken() : ApiTokenSecret|ErrorResponse: Operation createApiToken
createApiTokenAsync() : PromiseInterface: Operation createApiTokenAsync
createApiTokenAsyncWithHttpInfo() : PromiseInterface: Operation createApiTokenAsyncWithHttpInfo
createApiTokenRequest() : Request: Create request for operation 'createApiToken'
createApiTokenWithHttpInfo() : array<string|int, mixed>: Operation createApiTokenWithHttpInfo
createNodesToken() : AuthResult|ErrorResponse: Operation createNodesToken
createNodesTokenAsync() : PromiseInterface: Operation createNodesTokenAsync
createNodesTokenAsyncWithHttpInfo() : PromiseInterface: Operation createNodesTokenAsyncWithHttpInfo
createNodesTokenRequest() : Request: Create request for operation 'createNodesToken'
createNodesTokenWithHttpInfo() : array<string|int, mixed>: Operation createNodesTokenWithHttpInfo
createRecursiveNodeToken() : AuthResult|ErrorResponse: Operation createRecursiveNodeToken
createRecursiveNodeTokenAsync() : PromiseInterface: Operation createRecursiveNodeTokenAsync
createRecursiveNodeTokenAsyncWithHttpInfo() : PromiseInterface: Operation createRecursiveNodeTokenAsyncWithHttpInfo
createRecursiveNodeTokenRequest() : Request: Create request for operation 'createRecursiveNodeToken'
createRecursiveNodeTokenWithHttpInfo() : array<string|int, mixed>: Operation createRecursiveNodeTokenWithHttpInfo
createVersionsToken() : AuthResult|ErrorResponse: Operation createVersionsToken
createVersionsTokenAsync() : PromiseInterface: Operation createVersionsTokenAsync
createVersionsTokenAsyncWithHttpInfo() : PromiseInterface: Operation createVersionsTokenAsyncWithHttpInfo
createVersionsTokenRequest() : Request: Create request for operation 'createVersionsToken'
createVersionsTokenWithHttpInfo() : array<string|int, mixed>: Operation createVersionsTokenWithHttpInfo
deleteApiToken() : void: Operation deleteApiToken
deleteApiTokenAsync() : PromiseInterface: Operation deleteApiTokenAsync
deleteApiTokenAsyncWithHttpInfo() : PromiseInterface: Operation deleteApiTokenAsyncWithHttpInfo
deleteApiTokenRequest() : Request: Create request for operation 'deleteApiToken'
deleteApiTokenWithHttpInfo() : array<string|int, mixed>: Operation deleteApiTokenWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
getSession() : Session|ErrorResponse: Operation getSession
getSessionAsync() : PromiseInterface: Operation getSessionAsync
getSessionAsyncWithHttpInfo() : PromiseInterface: Operation getSessionAsyncWithHttpInfo
getSessionRequest() : Request: Create request for operation 'getSession'
getSessionWithHttpInfo() : array<string|int, mixed>: Operation getSessionWithHttpInfo
listApiTokens() : array<string|int, ApiToken>|ErrorResponse: Operation listApiTokens
listApiTokensAsync() : PromiseInterface: Operation listApiTokensAsync
listApiTokensAsyncWithHttpInfo() : PromiseInterface: Operation listApiTokensAsyncWithHttpInfo
listApiTokensRequest() : Request: Create request for operation 'listApiTokens'
listApiTokensWithHttpInfo() : array<string|int, mixed>: Operation listApiTokensWithHttpInfo
loginAnonymous() : AuthResult|ErrorResponse: Operation loginAnonymous
loginAnonymousAsync() : PromiseInterface: Operation loginAnonymousAsync
loginAnonymousAsyncWithHttpInfo() : PromiseInterface: Operation loginAnonymousAsyncWithHttpInfo
loginAnonymousRequest() : Request: Create request for operation 'loginAnonymous'
loginAnonymousWithHttpInfo() : array<string|int, mixed>: Operation loginAnonymousWithHttpInfo
loginWithAnonymousToken() : AuthResult|ErrorResponse: Operation loginWithAnonymousToken
loginWithAnonymousTokenAsync() : PromiseInterface: Operation loginWithAnonymousTokenAsync
loginWithAnonymousTokenAsyncWithHttpInfo() : PromiseInterface: Operation loginWithAnonymousTokenAsyncWithHttpInfo
loginWithAnonymousTokenRequest() : Request: Create request for operation 'loginWithAnonymousToken'
loginWithAnonymousTokenWithHttpInfo() : array<string|int, mixed>: Operation loginWithAnonymousTokenWithHttpInfo
loginWithApiToken() : AuthResult|ErrorResponse: Operation loginWithApiToken
loginWithApiTokenAsync() : PromiseInterface: Operation loginWithApiTokenAsync
loginWithApiTokenAsyncWithHttpInfo() : PromiseInterface: Operation loginWithApiTokenAsyncWithHttpInfo
loginWithApiTokenRequest() : Request: Create request for operation 'loginWithApiToken'
loginWithApiTokenWithHttpInfo() : array<string|int, mixed>: Operation loginWithApiTokenWithHttpInfo
loginWithUsernamePassword() : AuthResult|ErrorResponse: Operation loginWithUsernamePassword
loginWithUsernamePasswordAsync() : PromiseInterface: Operation loginWithUsernamePasswordAsync
loginWithUsernamePasswordAsyncWithHttpInfo() : PromiseInterface: Operation loginWithUsernamePasswordAsyncWithHttpInfo
loginWithUsernamePasswordRequest() : Request: Create request for operation 'loginWithUsernamePassword'
loginWithUsernamePasswordWithHttpInfo() : array<string|int, mixed>: Operation loginWithUsernamePasswordWithHttpInfo
setHostIndex() : void: Set the host index
updateApiToken() : ApiToken|ErrorResponse: Operation updateApiToken
updateApiTokenAsync() : PromiseInterface: Operation updateApiTokenAsync
updateApiTokenAsyncWithHttpInfo() : PromiseInterface: Operation updateApiTokenAsyncWithHttpInfo
updateApiTokenRequest() : Request: Create request for operation 'updateApiToken'
updateApiTokenWithHttpInfo() : array<string|int, mixed>: Operation updateApiTokenWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['createAnonymousToken' => ['application/json'], 'createApiToken' => ['application/json'], 'createNodesToken' => ['application/json'], 'createRecursiveNodeToken' => ['application/json'], 'createVersionsToken' => ['application/json'], 'deleteApiToken' => ['application/json'], 'getSession' => ['application/json'], 'listApiTokens' => ['application/json'], 'loginAnonymous' => ['application/json'], 'loginWithAnonymousToken' => ['application/json'], 'loginWithApiToken' => ['application/json'], 'loginWithUsernamePassword' => ['application/json'], 'updateApiToken' => ['application/json']]

$client


        protected
            ClientInterface
    $client

$config


        protected
            Configuration
    $config

$headerSelector


        protected
            HeaderSelector
    $headerSelector

$hostIndex


        protected
            int
    $hostIndex

Host index

__construct()


    public
                    __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int = 0: (Optional) host index to select the list of hosts if defined in the OpenAPI spec

createAnonymousToken()

Operation createAnonymousToken


    public
                    createAnonymousToken([CreateAnonymousTokenRequest|null $create_anonymous_token_request = null ][, string $contentType = self::contentTypes['createAnonymousToken'][0] ]) : CreateAnonymousTokenResult|ErrorResponse

Create an anonymous token, for using BIM.works without an account

Parameters

$create_anonymous_token_request : CreateAnonymousTokenRequest|null = null: create_anonymous_token_request (optional)
$contentType : string = self::contentTypes['createAnonymousToken'][0]: The value for the Content-Type header. Check self::contentTypes['createAnonymousToken'] to see the possible values for this operation

Return values

CreateAnonymousTokenResult|ErrorResponse

createAnonymousTokenAsync()

Operation createAnonymousTokenAsync


    public
                    createAnonymousTokenAsync([CreateAnonymousTokenRequest|null $create_anonymous_token_request = null ][, string $contentType = self::contentTypes['createAnonymousToken'][0] ]) : PromiseInterface

Create an anonymous token, for using BIM.works without an account

Parameters

$create_anonymous_token_request : CreateAnonymousTokenRequest|null = null: (optional)
$contentType : string = self::contentTypes['createAnonymousToken'][0]: The value for the Content-Type header. Check self::contentTypes['createAnonymousToken'] to see the possible values for this operation

Return values

PromiseInterface

createAnonymousTokenAsyncWithHttpInfo()

Operation createAnonymousTokenAsyncWithHttpInfo


    public
                    createAnonymousTokenAsyncWithHttpInfo([CreateAnonymousTokenRequest|null $create_anonymous_token_request = null ][, string $contentType = self::contentTypes['createAnonymousToken'][0] ]) : PromiseInterface

Create an anonymous token, for using BIM.works without an account

Parameters

$create_anonymous_token_request : CreateAnonymousTokenRequest|null = null: (optional)
$contentType : string = self::contentTypes['createAnonymousToken'][0]: The value for the Content-Type header. Check self::contentTypes['createAnonymousToken'] to see the possible values for this operation

Return values

PromiseInterface

createAnonymousTokenRequest()

Create request for operation 'createAnonymousToken'


    public
                    createAnonymousTokenRequest([CreateAnonymousTokenRequest|null $create_anonymous_token_request = null ][, string $contentType = self::contentTypes['createAnonymousToken'][0] ]) : Request

Parameters

$create_anonymous_token_request : CreateAnonymousTokenRequest|null = null: (optional)
$contentType : string = self::contentTypes['createAnonymousToken'][0]: The value for the Content-Type header. Check self::contentTypes['createAnonymousToken'] to see the possible values for this operation

Return values

Request

createAnonymousTokenWithHttpInfo()

Operation createAnonymousTokenWithHttpInfo


    public
                    createAnonymousTokenWithHttpInfo([CreateAnonymousTokenRequest|null $create_anonymous_token_request = null ][, string $contentType = self::contentTypes['createAnonymousToken'][0] ]) : array<string|int, mixed>

Create an anonymous token, for using BIM.works without an account

Parameters

$create_anonymous_token_request : CreateAnonymousTokenRequest|null = null: (optional)
$contentType : string = self::contentTypes['createAnonymousToken'][0]: The value for the Content-Type header. Check self::contentTypes['createAnonymousToken'] to see the possible values for this operation

Return values

array<string|int, mixed> —

createApiToken()

Operation createApiToken


    public
                    createApiToken(CreateApiTokenRequest $create_api_token_request[, string $contentType = self::contentTypes['createApiToken'][0] ]) : ApiTokenSecret|ErrorResponse

Create an API token

Parameters

$create_api_token_request : CreateApiTokenRequest: create_api_token_request (required)
$contentType : string = self::contentTypes['createApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['createApiToken'] to see the possible values for this operation

Return values

ApiTokenSecret|ErrorResponse

createApiTokenAsync()

Operation createApiTokenAsync


    public
                    createApiTokenAsync(CreateApiTokenRequest $create_api_token_request[, string $contentType = self::contentTypes['createApiToken'][0] ]) : PromiseInterface

Create an API token

Parameters

$create_api_token_request : CreateApiTokenRequest: (required)
$contentType : string = self::contentTypes['createApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['createApiToken'] to see the possible values for this operation

Return values

PromiseInterface

createApiTokenAsyncWithHttpInfo()

Operation createApiTokenAsyncWithHttpInfo


    public
                    createApiTokenAsyncWithHttpInfo(CreateApiTokenRequest $create_api_token_request[, string $contentType = self::contentTypes['createApiToken'][0] ]) : PromiseInterface

Create an API token

Parameters

$create_api_token_request : CreateApiTokenRequest: (required)
$contentType : string = self::contentTypes['createApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['createApiToken'] to see the possible values for this operation

Return values

PromiseInterface

createApiTokenRequest()

Create request for operation 'createApiToken'


    public
                    createApiTokenRequest(CreateApiTokenRequest $create_api_token_request[, string $contentType = self::contentTypes['createApiToken'][0] ]) : Request

Parameters

$create_api_token_request : CreateApiTokenRequest: (required)
$contentType : string = self::contentTypes['createApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['createApiToken'] to see the possible values for this operation

Return values

Request

createApiTokenWithHttpInfo()

Operation createApiTokenWithHttpInfo


    public
                    createApiTokenWithHttpInfo(CreateApiTokenRequest $create_api_token_request[, string $contentType = self::contentTypes['createApiToken'][0] ]) : array<string|int, mixed>

Create an API token

Parameters

$create_api_token_request : CreateApiTokenRequest: (required)
$contentType : string = self::contentTypes['createApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['createApiToken'] to see the possible values for this operation

Return values

array<string|int, mixed> —

createNodesToken()

Operation createNodesToken


    public
                    createNodesToken(CreateNodesTokenRequest $create_nodes_token_request[, string $contentType = self::contentTypes['createNodesToken'][0] ]) : AuthResult|ErrorResponse

Create a new token, based on a set of Nodes

Parameters

$create_nodes_token_request : CreateNodesTokenRequest: create_nodes_token_request (required)
$contentType : string = self::contentTypes['createNodesToken'][0]: The value for the Content-Type header. Check self::contentTypes['createNodesToken'] to see the possible values for this operation

Return values

AuthResult|ErrorResponse

createNodesTokenAsync()

Operation createNodesTokenAsync


    public
                    createNodesTokenAsync(CreateNodesTokenRequest $create_nodes_token_request[, string $contentType = self::contentTypes['createNodesToken'][0] ]) : PromiseInterface

Create a new token, based on a set of Nodes

Parameters

$create_nodes_token_request : CreateNodesTokenRequest: (required)
$contentType : string = self::contentTypes['createNodesToken'][0]: The value for the Content-Type header. Check self::contentTypes['createNodesToken'] to see the possible values for this operation

Return values

PromiseInterface

createNodesTokenAsyncWithHttpInfo()

Operation createNodesTokenAsyncWithHttpInfo


    public
                    createNodesTokenAsyncWithHttpInfo(CreateNodesTokenRequest $create_nodes_token_request[, string $contentType = self::contentTypes['createNodesToken'][0] ]) : PromiseInterface

Create a new token, based on a set of Nodes

Parameters

$create_nodes_token_request : CreateNodesTokenRequest: (required)
$contentType : string = self::contentTypes['createNodesToken'][0]: The value for the Content-Type header. Check self::contentTypes['createNodesToken'] to see the possible values for this operation

Return values

PromiseInterface

createNodesTokenRequest()

Create request for operation 'createNodesToken'


    public
                    createNodesTokenRequest(CreateNodesTokenRequest $create_nodes_token_request[, string $contentType = self::contentTypes['createNodesToken'][0] ]) : Request

Parameters

$create_nodes_token_request : CreateNodesTokenRequest: (required)
$contentType : string = self::contentTypes['createNodesToken'][0]: The value for the Content-Type header. Check self::contentTypes['createNodesToken'] to see the possible values for this operation

Return values

Request

createNodesTokenWithHttpInfo()

Operation createNodesTokenWithHttpInfo


    public
                    createNodesTokenWithHttpInfo(CreateNodesTokenRequest $create_nodes_token_request[, string $contentType = self::contentTypes['createNodesToken'][0] ]) : array<string|int, mixed>

Create a new token, based on a set of Nodes

Parameters

$create_nodes_token_request : CreateNodesTokenRequest: (required)
$contentType : string = self::contentTypes['createNodesToken'][0]: The value for the Content-Type header. Check self::contentTypes['createNodesToken'] to see the possible values for this operation

Return values

array<string|int, mixed> —

createRecursiveNodeToken()

Operation createRecursiveNodeToken


    public
                    createRecursiveNodeToken(CreateRecursiveNodeTokenRequest $create_recursive_node_token_request[, string $contentType = self::contentTypes['createRecursiveNodeToken'][0] ]) : AuthResult|ErrorResponse

Create a new token, based on a Node

Parameters

$create_recursive_node_token_request : CreateRecursiveNodeTokenRequest: create_recursive_node_token_request (required)
$contentType : string = self::contentTypes['createRecursiveNodeToken'][0]: The value for the Content-Type header. Check self::contentTypes['createRecursiveNodeToken'] to see the possible values for this operation

Return values

AuthResult|ErrorResponse

createRecursiveNodeTokenAsync()

Operation createRecursiveNodeTokenAsync


    public
                    createRecursiveNodeTokenAsync(CreateRecursiveNodeTokenRequest $create_recursive_node_token_request[, string $contentType = self::contentTypes['createRecursiveNodeToken'][0] ]) : PromiseInterface

Create a new token, based on a Node

Parameters

$create_recursive_node_token_request : CreateRecursiveNodeTokenRequest: (required)
$contentType : string = self::contentTypes['createRecursiveNodeToken'][0]: The value for the Content-Type header. Check self::contentTypes['createRecursiveNodeToken'] to see the possible values for this operation

Return values

PromiseInterface

createRecursiveNodeTokenAsyncWithHttpInfo()

Operation createRecursiveNodeTokenAsyncWithHttpInfo


    public
                    createRecursiveNodeTokenAsyncWithHttpInfo(CreateRecursiveNodeTokenRequest $create_recursive_node_token_request[, string $contentType = self::contentTypes['createRecursiveNodeToken'][0] ]) : PromiseInterface

Create a new token, based on a Node

Parameters

$create_recursive_node_token_request : CreateRecursiveNodeTokenRequest: (required)
$contentType : string = self::contentTypes['createRecursiveNodeToken'][0]: The value for the Content-Type header. Check self::contentTypes['createRecursiveNodeToken'] to see the possible values for this operation

Return values

PromiseInterface

createRecursiveNodeTokenRequest()

Create request for operation 'createRecursiveNodeToken'


    public
                    createRecursiveNodeTokenRequest(CreateRecursiveNodeTokenRequest $create_recursive_node_token_request[, string $contentType = self::contentTypes['createRecursiveNodeToken'][0] ]) : Request

Parameters

$create_recursive_node_token_request : CreateRecursiveNodeTokenRequest: (required)
$contentType : string = self::contentTypes['createRecursiveNodeToken'][0]: The value for the Content-Type header. Check self::contentTypes['createRecursiveNodeToken'] to see the possible values for this operation

Return values

Request

createRecursiveNodeTokenWithHttpInfo()

Operation createRecursiveNodeTokenWithHttpInfo


    public
                    createRecursiveNodeTokenWithHttpInfo(CreateRecursiveNodeTokenRequest $create_recursive_node_token_request[, string $contentType = self::contentTypes['createRecursiveNodeToken'][0] ]) : array<string|int, mixed>

Create a new token, based on a Node

Parameters

$create_recursive_node_token_request : CreateRecursiveNodeTokenRequest: (required)
$contentType : string = self::contentTypes['createRecursiveNodeToken'][0]: The value for the Content-Type header. Check self::contentTypes['createRecursiveNodeToken'] to see the possible values for this operation

Return values

array<string|int, mixed> —

createVersionsToken()

Operation createVersionsToken


    public
                    createVersionsToken(CreateVersionsTokenRequest $create_versions_token_request[, string $contentType = self::contentTypes['createVersionsToken'][0] ]) : AuthResult|ErrorResponse

Create a new token, based on a set of Versions

Parameters

$create_versions_token_request : CreateVersionsTokenRequest: create_versions_token_request (required)
$contentType : string = self::contentTypes['createVersionsToken'][0]: The value for the Content-Type header. Check self::contentTypes['createVersionsToken'] to see the possible values for this operation

Return values

AuthResult|ErrorResponse

createVersionsTokenAsync()

Operation createVersionsTokenAsync


    public
                    createVersionsTokenAsync(CreateVersionsTokenRequest $create_versions_token_request[, string $contentType = self::contentTypes['createVersionsToken'][0] ]) : PromiseInterface

Create a new token, based on a set of Versions

Parameters

$create_versions_token_request : CreateVersionsTokenRequest: (required)
$contentType : string = self::contentTypes['createVersionsToken'][0]: The value for the Content-Type header. Check self::contentTypes['createVersionsToken'] to see the possible values for this operation

Return values

PromiseInterface

createVersionsTokenAsyncWithHttpInfo()

Operation createVersionsTokenAsyncWithHttpInfo


    public
                    createVersionsTokenAsyncWithHttpInfo(CreateVersionsTokenRequest $create_versions_token_request[, string $contentType = self::contentTypes['createVersionsToken'][0] ]) : PromiseInterface

Create a new token, based on a set of Versions

Parameters

$create_versions_token_request : CreateVersionsTokenRequest: (required)
$contentType : string = self::contentTypes['createVersionsToken'][0]: The value for the Content-Type header. Check self::contentTypes['createVersionsToken'] to see the possible values for this operation

Return values

PromiseInterface

createVersionsTokenRequest()

Create request for operation 'createVersionsToken'


    public
                    createVersionsTokenRequest(CreateVersionsTokenRequest $create_versions_token_request[, string $contentType = self::contentTypes['createVersionsToken'][0] ]) : Request

Parameters

$create_versions_token_request : CreateVersionsTokenRequest: (required)
$contentType : string = self::contentTypes['createVersionsToken'][0]: The value for the Content-Type header. Check self::contentTypes['createVersionsToken'] to see the possible values for this operation

Return values

Request

createVersionsTokenWithHttpInfo()

Operation createVersionsTokenWithHttpInfo


    public
                    createVersionsTokenWithHttpInfo(CreateVersionsTokenRequest $create_versions_token_request[, string $contentType = self::contentTypes['createVersionsToken'][0] ]) : array<string|int, mixed>

Create a new token, based on a set of Versions

Parameters

$create_versions_token_request : CreateVersionsTokenRequest: (required)
$contentType : string = self::contentTypes['createVersionsToken'][0]: The value for the Content-Type header. Check self::contentTypes['createVersionsToken'] to see the possible values for this operation

Return values

array<string|int, mixed> —

deleteApiToken()

Operation deleteApiToken


    public
                    deleteApiToken(DeleteApiTokenRequest $delete_api_token_request[, string $contentType = self::contentTypes['deleteApiToken'][0] ]) : void

Revoke an API token

Parameters

$delete_api_token_request : DeleteApiTokenRequest: delete_api_token_request (required)
$contentType : string = self::contentTypes['deleteApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['deleteApiToken'] to see the possible values for this operation

deleteApiTokenAsync()

Operation deleteApiTokenAsync


    public
                    deleteApiTokenAsync(DeleteApiTokenRequest $delete_api_token_request[, string $contentType = self::contentTypes['deleteApiToken'][0] ]) : PromiseInterface

Revoke an API token

Parameters

$delete_api_token_request : DeleteApiTokenRequest: (required)
$contentType : string = self::contentTypes['deleteApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['deleteApiToken'] to see the possible values for this operation

Return values

PromiseInterface

deleteApiTokenAsyncWithHttpInfo()

Operation deleteApiTokenAsyncWithHttpInfo


    public
                    deleteApiTokenAsyncWithHttpInfo(DeleteApiTokenRequest $delete_api_token_request[, string $contentType = self::contentTypes['deleteApiToken'][0] ]) : PromiseInterface

Revoke an API token

Parameters

$delete_api_token_request : DeleteApiTokenRequest: (required)
$contentType : string = self::contentTypes['deleteApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['deleteApiToken'] to see the possible values for this operation

Return values

PromiseInterface

deleteApiTokenRequest()

Create request for operation 'deleteApiToken'


    public
                    deleteApiTokenRequest(DeleteApiTokenRequest $delete_api_token_request[, string $contentType = self::contentTypes['deleteApiToken'][0] ]) : Request

Parameters

$delete_api_token_request : DeleteApiTokenRequest: (required)
$contentType : string = self::contentTypes['deleteApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['deleteApiToken'] to see the possible values for this operation

Return values

Request

deleteApiTokenWithHttpInfo()

Operation deleteApiTokenWithHttpInfo


    public
                    deleteApiTokenWithHttpInfo(DeleteApiTokenRequest $delete_api_token_request[, string $contentType = self::contentTypes['deleteApiToken'][0] ]) : array<string|int, mixed>

Revoke an API token

Parameters

$delete_api_token_request : DeleteApiTokenRequest: (required)
$contentType : string = self::contentTypes['deleteApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['deleteApiToken'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

getSession()

Operation getSession


    public
                    getSession([string $contentType = self::contentTypes['getSession'][0] ]) : Session|ErrorResponse

Describe the session behind the bearer token

Parameters

$contentType : string = self::contentTypes['getSession'][0]: The value for the Content-Type header. Check self::contentTypes['getSession'] to see the possible values for this operation

Return values

Session|ErrorResponse

getSessionAsync()

Operation getSessionAsync


    public
                    getSessionAsync([string $contentType = self::contentTypes['getSession'][0] ]) : PromiseInterface

Describe the session behind the bearer token

Parameters

$contentType : string = self::contentTypes['getSession'][0]: The value for the Content-Type header. Check self::contentTypes['getSession'] to see the possible values for this operation

Return values

PromiseInterface

getSessionAsyncWithHttpInfo()

Operation getSessionAsyncWithHttpInfo


    public
                    getSessionAsyncWithHttpInfo([string $contentType = self::contentTypes['getSession'][0] ]) : PromiseInterface

Describe the session behind the bearer token

Parameters

$contentType : string = self::contentTypes['getSession'][0]: The value for the Content-Type header. Check self::contentTypes['getSession'] to see the possible values for this operation

Return values

PromiseInterface

getSessionRequest()

Create request for operation 'getSession'


    public
                    getSessionRequest([string $contentType = self::contentTypes['getSession'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['getSession'][0]: The value for the Content-Type header. Check self::contentTypes['getSession'] to see the possible values for this operation

Return values

Request

getSessionWithHttpInfo()

Operation getSessionWithHttpInfo


    public
                    getSessionWithHttpInfo([string $contentType = self::contentTypes['getSession'][0] ]) : array<string|int, mixed>

Describe the session behind the bearer token

Parameters

$contentType : string = self::contentTypes['getSession'][0]: The value for the Content-Type header. Check self::contentTypes['getSession'] to see the possible values for this operation

Return values

array<string|int, mixed> —

listApiTokens()

Operation listApiTokens


    public
                    listApiTokens([ListApiTokensRequest|null $list_api_tokens_request = null ][, string $contentType = self::contentTypes['listApiTokens'][0] ]) : array<string|int, ApiToken>|ErrorResponse

List API tokens

Parameters

$list_api_tokens_request : ListApiTokensRequest|null = null: list_api_tokens_request (optional)
$contentType : string = self::contentTypes['listApiTokens'][0]: The value for the Content-Type header. Check self::contentTypes['listApiTokens'] to see the possible values for this operation

Return values

array<string|int, ApiToken>|ErrorResponse

listApiTokensAsync()

Operation listApiTokensAsync


    public
                    listApiTokensAsync([ListApiTokensRequest|null $list_api_tokens_request = null ][, string $contentType = self::contentTypes['listApiTokens'][0] ]) : PromiseInterface

List API tokens

Parameters

$list_api_tokens_request : ListApiTokensRequest|null = null: (optional)
$contentType : string = self::contentTypes['listApiTokens'][0]: The value for the Content-Type header. Check self::contentTypes['listApiTokens'] to see the possible values for this operation

Return values

PromiseInterface

listApiTokensAsyncWithHttpInfo()

Operation listApiTokensAsyncWithHttpInfo


    public
                    listApiTokensAsyncWithHttpInfo([ListApiTokensRequest|null $list_api_tokens_request = null ][, string $contentType = self::contentTypes['listApiTokens'][0] ]) : PromiseInterface

List API tokens

Parameters

$list_api_tokens_request : ListApiTokensRequest|null = null: (optional)
$contentType : string = self::contentTypes['listApiTokens'][0]: The value for the Content-Type header. Check self::contentTypes['listApiTokens'] to see the possible values for this operation

Return values

PromiseInterface

listApiTokensRequest()

Create request for operation 'listApiTokens'


    public
                    listApiTokensRequest([ListApiTokensRequest|null $list_api_tokens_request = null ][, string $contentType = self::contentTypes['listApiTokens'][0] ]) : Request

Parameters

$list_api_tokens_request : ListApiTokensRequest|null = null: (optional)
$contentType : string = self::contentTypes['listApiTokens'][0]: The value for the Content-Type header. Check self::contentTypes['listApiTokens'] to see the possible values for this operation

Return values

Request

listApiTokensWithHttpInfo()

Operation listApiTokensWithHttpInfo


    public
                    listApiTokensWithHttpInfo([ListApiTokensRequest|null $list_api_tokens_request = null ][, string $contentType = self::contentTypes['listApiTokens'][0] ]) : array<string|int, mixed>

List API tokens

Parameters

$list_api_tokens_request : ListApiTokensRequest|null = null: (optional)
$contentType : string = self::contentTypes['listApiTokens'][0]: The value for the Content-Type header. Check self::contentTypes['listApiTokens'] to see the possible values for this operation

Return values

array<string|int, mixed> —

loginAnonymous()

Operation loginAnonymous


    public
                    loginAnonymous([LoginAnonymousRequest|null $login_anonymous_request = null ][, string $contentType = self::contentTypes['loginAnonymous'][0] ]) : AuthResult|ErrorResponse

Parameters

$login_anonymous_request : LoginAnonymousRequest|null = null: login_anonymous_request (optional)
$contentType : string = self::contentTypes['loginAnonymous'][0]: The value for the Content-Type header. Check self::contentTypes['loginAnonymous'] to see the possible values for this operation

Return values

AuthResult|ErrorResponse

loginAnonymousAsync()

Operation loginAnonymousAsync


    public
                    loginAnonymousAsync([LoginAnonymousRequest|null $login_anonymous_request = null ][, string $contentType = self::contentTypes['loginAnonymous'][0] ]) : PromiseInterface

Parameters

$login_anonymous_request : LoginAnonymousRequest|null = null: (optional)
$contentType : string = self::contentTypes['loginAnonymous'][0]: The value for the Content-Type header. Check self::contentTypes['loginAnonymous'] to see the possible values for this operation

Return values

PromiseInterface

loginAnonymousAsyncWithHttpInfo()

Operation loginAnonymousAsyncWithHttpInfo


    public
                    loginAnonymousAsyncWithHttpInfo([LoginAnonymousRequest|null $login_anonymous_request = null ][, string $contentType = self::contentTypes['loginAnonymous'][0] ]) : PromiseInterface

Parameters

$login_anonymous_request : LoginAnonymousRequest|null = null: (optional)
$contentType : string = self::contentTypes['loginAnonymous'][0]: The value for the Content-Type header. Check self::contentTypes['loginAnonymous'] to see the possible values for this operation

Return values

PromiseInterface

loginAnonymousRequest()

Create request for operation 'loginAnonymous'


    public
                    loginAnonymousRequest([LoginAnonymousRequest|null $login_anonymous_request = null ][, string $contentType = self::contentTypes['loginAnonymous'][0] ]) : Request

Parameters

$login_anonymous_request : LoginAnonymousRequest|null = null: (optional)
$contentType : string = self::contentTypes['loginAnonymous'][0]: The value for the Content-Type header. Check self::contentTypes['loginAnonymous'] to see the possible values for this operation

Return values

Request

loginAnonymousWithHttpInfo()

Operation loginAnonymousWithHttpInfo


    public
                    loginAnonymousWithHttpInfo([LoginAnonymousRequest|null $login_anonymous_request = null ][, string $contentType = self::contentTypes['loginAnonymous'][0] ]) : array<string|int, mixed>

Parameters

$login_anonymous_request : LoginAnonymousRequest|null = null: (optional)
$contentType : string = self::contentTypes['loginAnonymous'][0]: The value for the Content-Type header. Check self::contentTypes['loginAnonymous'] to see the possible values for this operation

Return values

array<string|int, mixed> —

loginWithAnonymousToken()

Operation loginWithAnonymousToken


    public
                    loginWithAnonymousToken(LoginWithAnonymousTokenRequest $login_with_anonymous_token_request[, string $contentType = self::contentTypes['loginWithAnonymousToken'][0] ]) : AuthResult|ErrorResponse

Parameters

$login_with_anonymous_token_request : LoginWithAnonymousTokenRequest: login_with_anonymous_token_request (required)
$contentType : string = self::contentTypes['loginWithAnonymousToken'][0]: The value for the Content-Type header. Check self::contentTypes['loginWithAnonymousToken'] to see the possible values for this operation

Return values

AuthResult|ErrorResponse

loginWithAnonymousTokenAsync()

Operation loginWithAnonymousTokenAsync


    public
                    loginWithAnonymousTokenAsync(LoginWithAnonymousTokenRequest $login_with_anonymous_token_request[, string $contentType = self::contentTypes['loginWithAnonymousToken'][0] ]) : PromiseInterface

Parameters

$login_with_anonymous_token_request : LoginWithAnonymousTokenRequest: (required)
$contentType : string = self::contentTypes['loginWithAnonymousToken'][0]: The value for the Content-Type header. Check self::contentTypes['loginWithAnonymousToken'] to see the possible values for this operation

Return values

PromiseInterface

loginWithAnonymousTokenAsyncWithHttpInfo()

Operation loginWithAnonymousTokenAsyncWithHttpInfo


    public
                    loginWithAnonymousTokenAsyncWithHttpInfo(LoginWithAnonymousTokenRequest $login_with_anonymous_token_request[, string $contentType = self::contentTypes['loginWithAnonymousToken'][0] ]) : PromiseInterface

Parameters

$login_with_anonymous_token_request : LoginWithAnonymousTokenRequest: (required)
$contentType : string = self::contentTypes['loginWithAnonymousToken'][0]: The value for the Content-Type header. Check self::contentTypes['loginWithAnonymousToken'] to see the possible values for this operation

Return values

PromiseInterface

loginWithAnonymousTokenRequest()

Create request for operation 'loginWithAnonymousToken'


    public
                    loginWithAnonymousTokenRequest(LoginWithAnonymousTokenRequest $login_with_anonymous_token_request[, string $contentType = self::contentTypes['loginWithAnonymousToken'][0] ]) : Request

Parameters

$login_with_anonymous_token_request : LoginWithAnonymousTokenRequest: (required)
$contentType : string = self::contentTypes['loginWithAnonymousToken'][0]: The value for the Content-Type header. Check self::contentTypes['loginWithAnonymousToken'] to see the possible values for this operation

Return values

Request

loginWithAnonymousTokenWithHttpInfo()

Operation loginWithAnonymousTokenWithHttpInfo


    public
                    loginWithAnonymousTokenWithHttpInfo(LoginWithAnonymousTokenRequest $login_with_anonymous_token_request[, string $contentType = self::contentTypes['loginWithAnonymousToken'][0] ]) : array<string|int, mixed>

Parameters

$login_with_anonymous_token_request : LoginWithAnonymousTokenRequest: (required)
$contentType : string = self::contentTypes['loginWithAnonymousToken'][0]: The value for the Content-Type header. Check self::contentTypes['loginWithAnonymousToken'] to see the possible values for this operation

Return values

array<string|int, mixed> —

loginWithApiToken()

Operation loginWithApiToken


    public
                    loginWithApiToken(LoginWithApiTokenRequest $login_with_api_token_request[, string $contentType = self::contentTypes['loginWithApiToken'][0] ]) : AuthResult|ErrorResponse

Parameters

$login_with_api_token_request : LoginWithApiTokenRequest: login_with_api_token_request (required)
$contentType : string = self::contentTypes['loginWithApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['loginWithApiToken'] to see the possible values for this operation

Return values

AuthResult|ErrorResponse

loginWithApiTokenAsync()

Operation loginWithApiTokenAsync


    public
                    loginWithApiTokenAsync(LoginWithApiTokenRequest $login_with_api_token_request[, string $contentType = self::contentTypes['loginWithApiToken'][0] ]) : PromiseInterface

Parameters

$login_with_api_token_request : LoginWithApiTokenRequest: (required)
$contentType : string = self::contentTypes['loginWithApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['loginWithApiToken'] to see the possible values for this operation

Return values

PromiseInterface

loginWithApiTokenAsyncWithHttpInfo()

Operation loginWithApiTokenAsyncWithHttpInfo


    public
                    loginWithApiTokenAsyncWithHttpInfo(LoginWithApiTokenRequest $login_with_api_token_request[, string $contentType = self::contentTypes['loginWithApiToken'][0] ]) : PromiseInterface

Parameters

$login_with_api_token_request : LoginWithApiTokenRequest: (required)
$contentType : string = self::contentTypes['loginWithApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['loginWithApiToken'] to see the possible values for this operation

Return values

PromiseInterface

loginWithApiTokenRequest()

Create request for operation 'loginWithApiToken'


    public
                    loginWithApiTokenRequest(LoginWithApiTokenRequest $login_with_api_token_request[, string $contentType = self::contentTypes['loginWithApiToken'][0] ]) : Request

Parameters

$login_with_api_token_request : LoginWithApiTokenRequest: (required)
$contentType : string = self::contentTypes['loginWithApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['loginWithApiToken'] to see the possible values for this operation

Return values

Request

loginWithApiTokenWithHttpInfo()

Operation loginWithApiTokenWithHttpInfo


    public
                    loginWithApiTokenWithHttpInfo(LoginWithApiTokenRequest $login_with_api_token_request[, string $contentType = self::contentTypes['loginWithApiToken'][0] ]) : array<string|int, mixed>

Parameters

$login_with_api_token_request : LoginWithApiTokenRequest: (required)
$contentType : string = self::contentTypes['loginWithApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['loginWithApiToken'] to see the possible values for this operation

Return values

array<string|int, mixed> —

loginWithUsernamePassword()

Operation loginWithUsernamePassword


    public
                    loginWithUsernamePassword(LoginWithUsernamePasswordRequest $login_with_username_password_request[, string $contentType = self::contentTypes['loginWithUsernamePassword'][0] ]) : AuthResult|ErrorResponse

Parameters

$login_with_username_password_request : LoginWithUsernamePasswordRequest: login_with_username_password_request (required)
$contentType : string = self::contentTypes['loginWithUsernamePassword'][0]: The value for the Content-Type header. Check self::contentTypes['loginWithUsernamePassword'] to see the possible values for this operation

Return values

AuthResult|ErrorResponse

loginWithUsernamePasswordAsync()

Operation loginWithUsernamePasswordAsync


    public
                    loginWithUsernamePasswordAsync(LoginWithUsernamePasswordRequest $login_with_username_password_request[, string $contentType = self::contentTypes['loginWithUsernamePassword'][0] ]) : PromiseInterface

Parameters

$login_with_username_password_request : LoginWithUsernamePasswordRequest: (required)
$contentType : string = self::contentTypes['loginWithUsernamePassword'][0]: The value for the Content-Type header. Check self::contentTypes['loginWithUsernamePassword'] to see the possible values for this operation

Return values

PromiseInterface

loginWithUsernamePasswordAsyncWithHttpInfo()

Operation loginWithUsernamePasswordAsyncWithHttpInfo


    public
                    loginWithUsernamePasswordAsyncWithHttpInfo(LoginWithUsernamePasswordRequest $login_with_username_password_request[, string $contentType = self::contentTypes['loginWithUsernamePassword'][0] ]) : PromiseInterface

Parameters

$login_with_username_password_request : LoginWithUsernamePasswordRequest: (required)
$contentType : string = self::contentTypes['loginWithUsernamePassword'][0]: The value for the Content-Type header. Check self::contentTypes['loginWithUsernamePassword'] to see the possible values for this operation

Return values

PromiseInterface

loginWithUsernamePasswordRequest()

Create request for operation 'loginWithUsernamePassword'


    public
                    loginWithUsernamePasswordRequest(LoginWithUsernamePasswordRequest $login_with_username_password_request[, string $contentType = self::contentTypes['loginWithUsernamePassword'][0] ]) : Request

Parameters

$login_with_username_password_request : LoginWithUsernamePasswordRequest: (required)
$contentType : string = self::contentTypes['loginWithUsernamePassword'][0]: The value for the Content-Type header. Check self::contentTypes['loginWithUsernamePassword'] to see the possible values for this operation

Return values

Request

loginWithUsernamePasswordWithHttpInfo()

Operation loginWithUsernamePasswordWithHttpInfo


    public
                    loginWithUsernamePasswordWithHttpInfo(LoginWithUsernamePasswordRequest $login_with_username_password_request[, string $contentType = self::contentTypes['loginWithUsernamePassword'][0] ]) : array<string|int, mixed>

Parameters

$login_with_username_password_request : LoginWithUsernamePasswordRequest: (required)
$contentType : string = self::contentTypes['loginWithUsernamePassword'][0]: The value for the Content-Type header. Check self::contentTypes['loginWithUsernamePassword'] to see the possible values for this operation

Return values

array<string|int, mixed> —

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

updateApiToken()

Operation updateApiToken


    public
                    updateApiToken(UpdateApiTokenRequest $update_api_token_request[, string $contentType = self::contentTypes['updateApiToken'][0] ]) : ApiToken|ErrorResponse

Change an API token

Parameters

$update_api_token_request : UpdateApiTokenRequest: update_api_token_request (required)
$contentType : string = self::contentTypes['updateApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['updateApiToken'] to see the possible values for this operation

Return values

ApiToken|ErrorResponse

updateApiTokenAsync()

Operation updateApiTokenAsync


    public
                    updateApiTokenAsync(UpdateApiTokenRequest $update_api_token_request[, string $contentType = self::contentTypes['updateApiToken'][0] ]) : PromiseInterface

Change an API token

Parameters

$update_api_token_request : UpdateApiTokenRequest: (required)
$contentType : string = self::contentTypes['updateApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['updateApiToken'] to see the possible values for this operation

Return values

PromiseInterface

updateApiTokenAsyncWithHttpInfo()

Operation updateApiTokenAsyncWithHttpInfo


    public
                    updateApiTokenAsyncWithHttpInfo(UpdateApiTokenRequest $update_api_token_request[, string $contentType = self::contentTypes['updateApiToken'][0] ]) : PromiseInterface

Change an API token

Parameters

$update_api_token_request : UpdateApiTokenRequest: (required)
$contentType : string = self::contentTypes['updateApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['updateApiToken'] to see the possible values for this operation

Return values

PromiseInterface

updateApiTokenRequest()

Create request for operation 'updateApiToken'


    public
                    updateApiTokenRequest(UpdateApiTokenRequest $update_api_token_request[, string $contentType = self::contentTypes['updateApiToken'][0] ]) : Request

Parameters

$update_api_token_request : UpdateApiTokenRequest: (required)
$contentType : string = self::contentTypes['updateApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['updateApiToken'] to see the possible values for this operation

Return values

Request

updateApiTokenWithHttpInfo()

Operation updateApiTokenWithHttpInfo


    public
                    updateApiTokenWithHttpInfo(UpdateApiTokenRequest $update_api_token_request[, string $contentType = self::contentTypes['updateApiToken'][0] ]) : array<string|int, mixed>

Change an API token

Parameters

$update_api_token_request : UpdateApiTokenRequest: (required)
$contentType : string = self::contentTypes['updateApiToken'][0]: The value for the Content-Type header. Check self::contentTypes['updateApiToken'] to see the possible values for this operation

Return values

array<string|int, mixed> —

createHttpClientOption()

Create http client option


    protected
                    createHttpClientOption() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of http client options

handleResponseWithDataType()


    private
                    handleResponseWithDataType(string $dataType, RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>

Parameters

$dataType : string
$request : RequestInterface
$response : ResponseInterface

Return values

array<string|int, mixed>

responseWithinRangeCode()


    private
                    responseWithinRangeCode(string $rangeCode, int $statusCode) : bool

Parameters

$rangeCode : string
$statusCode : int

Return values

bool

AuthApi in package BIMworks

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

createAnonymousToken()

Parameters

Tags

Return values

createAnonymousTokenAsync()

Parameters

Tags

Return values

createAnonymousTokenAsyncWithHttpInfo()

Parameters

Tags

Return values

createAnonymousTokenRequest()

Parameters

Tags

Return values

createAnonymousTokenWithHttpInfo()

Parameters

Tags

Return values

createApiToken()

Parameters

Tags

Return values

createApiTokenAsync()

Parameters

Tags

Return values

createApiTokenAsyncWithHttpInfo()

Parameters

Tags

Return values

createApiTokenRequest()

Parameters

Tags

Return values

createApiTokenWithHttpInfo()

Parameters

Tags

Return values

createNodesToken()

Parameters

Tags

Return values

createNodesTokenAsync()

Parameters

Tags

Return values

createNodesTokenAsyncWithHttpInfo()

Parameters

Tags

Return values

createNodesTokenRequest()

Parameters

Tags

Return values

createNodesTokenWithHttpInfo()

Parameters

Tags

Return values

createRecursiveNodeToken()

Parameters

Tags

Return values

AuthApi
in package

BIMworks