SmoochApi::ServiceAccountApi

All URIs are relative to https://api.smooch.io

Method	HTTP request	Description
create_secret_key	POST /v1.1/serviceaccounts/serviceAccountId/keys
create_service_account	POST /v1.1/serviceaccounts
delete_secret_key	DELETE /v1.1/serviceaccounts/serviceAccountId/keys/keyId
delete_service_account	DELETE /v1.1/serviceaccounts/serviceAccountId
get_jwt	GET /v1.1/serviceaccounts/serviceAccountId/keys/keyId/jwt
get_secret_key	GET /v1.1/serviceaccounts/serviceAccountId/keys/keyId
get_service_account	GET /v1.1/serviceaccounts/serviceAccountId
list_secret_keys	GET /v1.1/serviceaccounts/serviceAccountId/keys
list_service_accounts	GET /v1.1/serviceaccounts
update_service_account	PUT /v1.1/serviceaccounts/serviceAccountId

create_secret_key

SecretKeyResponse create_secret_key(serviceAccountId, secretKeyCreateBody)

Create a secret key for the specified service account.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::ServiceAccountApi.new

serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.

secretKeyCreateBody = SmoochApi::SecretKeyCreate.new # SecretKeyCreate | Body for a createSecretKey request.


begin
  result = api_instance.create_secret_key(serviceAccountId, secretKeyCreateBody)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling ServiceAccountApi->create_secret_key: #{e}"
end

Parameters

Name	Type	Description	Notes
serviceAccountId	String	Identifies the service account.
secretKeyCreateBody	SecretKeyCreate	Body for a createSecretKey request.

Return type

SecretKeyResponse

Authorization

basicAuth, jwt

HTTP request headers

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

create_service_account

ServiceAccountResponse create_service_account(serviceAccountCreateBody)

Create a new service account.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::ServiceAccountApi.new

serviceAccountCreateBody = SmoochApi::ServiceAccountCreate.new # ServiceAccountCreate | Body for a createServiceAccount request.


begin
  result = api_instance.create_service_account(serviceAccountCreateBody)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling ServiceAccountApi->create_service_account: #{e}"
end

Parameters

Name	Type	Description	Notes
serviceAccountCreateBody	ServiceAccountCreate	Body for a createServiceAccount request.

Return type

ServiceAccountResponse

Authorization

basicAuth, jwt

HTTP request headers

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

delete_secret_key

delete_secret_key(serviceAccountId, keyId)

Delete the specified service account secret key.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::ServiceAccountApi.new

serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.

keyId = "keyId_example" # String | Identifies the secret key.


begin
  api_instance.delete_secret_key(serviceAccountId, keyId)
rescue SmoochApi::ApiError => e
  puts "Exception when calling ServiceAccountApi->delete_secret_key: #{e}"
end

Parameters

Name	Type	Description	Notes
serviceAccountId	String	Identifies the service account.
keyId	String	Identifies the secret key.

Return type

nil (empty response body)

Authorization

basicAuth, jwt

HTTP request headers

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

delete_service_account

delete_service_account(serviceAccountId)

Delete the specified service account.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::ServiceAccountApi.new

serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.


begin
  api_instance.delete_service_account(serviceAccountId)
rescue SmoochApi::ApiError => e
  puts "Exception when calling ServiceAccountApi->delete_service_account: #{e}"
end

Parameters

Name	Type	Description	Notes
serviceAccountId	String	Identifies the service account.

Return type

nil (empty response body)

Authorization

basicAuth, jwt

HTTP request headers

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

get_jwt

JwtResponse get_jwt(serviceAccountId, keyId)

Get an account-scoped JWT for the specified service account secret key.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::ServiceAccountApi.new

serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.

keyId = "keyId_example" # String | Identifies the secret key.


begin
  result = api_instance.get_jwt(serviceAccountId, keyId)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling ServiceAccountApi->get_jwt: #{e}"
end

Parameters

Name	Type	Description	Notes
serviceAccountId	String	Identifies the service account.
keyId	String	Identifies the secret key.

Return type

JwtResponse

Authorization

basicAuth, jwt

HTTP request headers

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

get_secret_key

SecretKeyResponse get_secret_key(serviceAccountId, keyId)

Get the specified service account secret key.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::ServiceAccountApi.new

serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.

keyId = "keyId_example" # String | Identifies the secret key.


begin
  result = api_instance.get_secret_key(serviceAccountId, keyId)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling ServiceAccountApi->get_secret_key: #{e}"
end

Parameters

Name	Type	Description	Notes
serviceAccountId	String	Identifies the service account.
keyId	String	Identifies the secret key.

Return type

SecretKeyResponse

Authorization

basicAuth, jwt

HTTP request headers

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

get_service_account

ServiceAccountResponse get_service_account(serviceAccountId)

Get the specified service account.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::ServiceAccountApi.new

serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.


begin
  result = api_instance.get_service_account(serviceAccountId)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling ServiceAccountApi->get_service_account: #{e}"
end

Parameters

Name	Type	Description	Notes
serviceAccountId	String	Identifies the service account.

Return type

ServiceAccountResponse

Authorization

basicAuth, jwt

HTTP request headers

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

list_secret_keys

ListSecretKeysResponse list_secret_keys(serviceAccountId)

List the secret keys for the specified service account.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::ServiceAccountApi.new

serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.


begin
  result = api_instance.list_secret_keys(serviceAccountId)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling ServiceAccountApi->list_secret_keys: #{e}"
end

Parameters

Name	Type	Description	Notes
serviceAccountId	String	Identifies the service account.

Return type

ListSecretKeysResponse

Authorization

basicAuth, jwt

HTTP request headers

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

list_service_accounts

ListServiceAccountsResponse list_service_accounts(limit, offset)

List all service accounts configured.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::ServiceAccountApi.new

opts = { 
  limit: 25, # Integer | The number of records to return.
  offset: 0 # Integer | The number of initial records to skip before picking records to return.
}

begin
  result = api_instance.list_service_accounts(limit, offset)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling ServiceAccountApi->list_service_accounts: #{e}"
end

Parameters

Name	Type	Description	Notes
limit	Integer	The number of records to return.	[optional] [default to 25]
offset	Integer	The number of initial records to skip before picking records to return.	[optional] [default to 0]

Return type

ListServiceAccountsResponse

Authorization

basicAuth, jwt

HTTP request headers

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

update_service_account

ServiceAccountResponse update_service_account(serviceAccountId, serviceAccountUpdateBody)

Update the specified service account.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::ServiceAccountApi.new

serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.

serviceAccountUpdateBody = SmoochApi::ServiceAccountUpdate.new # ServiceAccountUpdate | Body for an updateServiceAccount request.


begin
  result = api_instance.update_service_account(serviceAccountId, serviceAccountUpdateBody)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling ServiceAccountApi->update_service_account: #{e}"
end

Parameters

Name	Type	Description	Notes
serviceAccountId	String	Identifies the service account.
serviceAccountUpdateBody	ServiceAccountUpdate	Body for an updateServiceAccount request.

Return type

ServiceAccountResponse

Authorization

basicAuth, jwt

HTTP request headers

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