Methods
deleteAuthTokenUrl(tokenId) → {string}
Generate a URL for deleting an auth token, via a DELETE request.
| Name | Type | Description |
|---|---|---|
tokenId | string | the token ID to delete |
the URL
- Type:
- string
generateAuthTokenUrl(type) → {string}
Generate a URL for creating a new auth token, via a POST request.
The request body accepts a module:domain~SecurityPolicy JSON document.
| Name | Type | Description |
|---|---|---|
type | AuthTokenType | the auth token type to generate |
the URL
- Type:
- string
listAllAuthTokensUrl() → {string}
Generate a URL for listing all available auth tokens.
the URL
- Type:
- string
replaceAuthTokenSecurityPolicyUrl(tokenId) → {string}
Generate a URL for replacing a security policy on an auth token, via a PUT request.
The request body accepts a module:domain~SecurityPolicy JSON document.
| Name | Type | Description |
|---|---|---|
tokenId | string | the ID of the token to update |
the URL
- Type:
- string
updateAuthTokenSecurityPolicyUrl(tokenId) → {string}
Generate a URL for updating (merging) a security policy on an auth token, via a PATCH request.
The request body accepts a module:net~SecurityPolicy JSON document.
| Name | Type | Description |
|---|---|---|
tokenId | string | the ID of the token to update |
the URL
- Type:
- string
updateAuthTokenStatusUrl(tokenId, status) → {string}
Generate a URL for updating the status of an auth token, via a POST request.
| Name | Type | Description |
|---|---|---|
tokenId | string | the ID of the token to update |
status | AuthTokenStatus | the status to change to |
the URL
- Type:
- string