Skip to content

Latest commit

 

History

History
219 lines (138 loc) · 7.83 KB

ServiceTokensApi.md

File metadata and controls

219 lines (138 loc) · 7.83 KB
Raw

{{classname}}

All URIs are relative to https://api.equinix.com

Method HTTP request Description
CreateServiceToken Post /fabric/v4/serviceTokens Create Service Token
CreateServiceTokenAction Post /fabric/v4/serviceTokens/{serviceTokenId}/actions ServiceToken Actions
DeleteServiceTokenByUuid Delete /fabric/v4/serviceTokens/{serviceTokenId} Delete Token by uuid
GetServiceTokenByUuid Get /fabric/v4/serviceTokens/{serviceTokenId} Get Token by uuid
GetServiceTokens Get /fabric/v4/serviceTokens Get All Tokens
SearchServiceTokens Post /fabric/v4/serviceTokens/search Search servicetokens
UpdateServiceTokenByUuid Patch /fabric/v4/serviceTokens/{serviceTokenId} Update Token By ID

CreateServiceToken

ServiceToken CreateServiceToken(ctx, body) Create Service Token

Create Service Tokens generates Equinix Fabric? service tokens. These tokens authorize users to access protected resources and services.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body ServiceToken

Return type

ServiceToken

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateServiceTokenAction

ServiceToken CreateServiceTokenAction(ctx, body, serviceTokenId) ServiceToken Actions

This API provides capability to accept/reject user's servicetokens

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body ServiceTokenActionRequest
serviceTokenId string Service Token UUID

Return type

ServiceToken

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteServiceTokenByUuid

DeleteServiceTokenByUuid(ctx, serviceTokenId) Delete Token by uuid

Delete Service Tokens removes an Equinix Fabric service token corresponding to the specified uuid which are in INACTIVE state.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceTokenId string Service Token UUID

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetServiceTokenByUuid

ServiceToken GetServiceTokenByUuid(ctx, serviceTokenId) Get Token by uuid

Get Specified Service Tokens uses the uuid of an Equinix Fabric service token to return details about the token's type, state, location, bandwidth, and other key properties.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceTokenId string Service Token UUID

Return type

ServiceToken

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetServiceTokens

ServiceTokens GetServiceTokens(ctx, optional) Get All Tokens

Get All ServiceTokens creates a list of all Equinix Fabric service tokens associated with the subscriber's account.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ServiceTokensApiGetServiceTokensOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ServiceTokensApiGetServiceTokensOpts struct

Name Type Description Notes
offset optional.Float64 offset
limit optional.Float64 number of records to fetch

Return type

ServiceTokens

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SearchServiceTokens

ServiceTokens SearchServiceTokens(ctx, body) Search servicetokens

The API provides capability to get list of user's servicetokens using search criteria, including optional filtering, pagination and sorting

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body ServiceTokenSearchRequest

Return type

ServiceTokens

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateServiceTokenByUuid

ServiceToken UpdateServiceTokenByUuid(ctx, body, serviceTokenId) Update Token By ID

This API provides capability to update user's Service Token

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body []ServiceTokenChangeOperation
serviceTokenId string Service Token UUID

Return type

ServiceToken

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json-patch+json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]