cloudsmith_api.EntitlementsApi

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

Method	HTTP request	Description
entitlements_create	POST /entitlements/{owner}/{repo}/	Create a specific entitlement in a repository.
entitlements_delete	DELETE /entitlements/{owner}/{repo}/{identifier}/	Delete a specific entitlement in a repository.
entitlements_disable	POST /entitlements/{owner}/{repo}/{identifier}/disable/	Disable an entitlement token in a repository.
entitlements_enable	POST /entitlements/{owner}/{repo}/{identifier}/enable/	Enable an entitlement token in a repository.
entitlements_list	GET /entitlements/{owner}/{repo}/	Get a list of all entitlements in a repository.
entitlements_partial_update	PATCH /entitlements/{owner}/{repo}/{identifier}/	Update a specific entitlement in a repository.
entitlements_read	GET /entitlements/{owner}/{repo}/{identifier}/	Get a specific entitlement in a repository.
entitlements_refresh	POST /entitlements/{owner}/{repo}/{identifier}/refresh/	Refresh an entitlement token in a repository.
entitlements_reset	POST /entitlements/{owner}/{repo}/{identifier}/reset/	Reset the statistics for an entitlement token in a repository.
entitlements_sync	POST /entitlements/{owner}/{repo}/sync/	Synchronise tokens from a source repository.
entitlements_toggle_private_broadcasts	POST /entitlements/{owner}/{repo}/{identifier}/toggle-private-broadcasts/	Set private broadcast access for an entitlement token in a repository.

entitlements_create

RepositoryToken entitlements_create(owner, repo, data=data, show_tokens=show_tokens)

Create a specific entitlement in a repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.EntitlementsApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
data = cloudsmith_api.RepositoryTokenRequest() # RepositoryTokenRequest |  (optional)
show_tokens = false # bool | Show entitlement token strings in results (optional) (default to false)

try:
    # Create a specific entitlement in a repository.
    api_response = api_instance.entitlements_create(owner, repo, data=data, show_tokens=show_tokens)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitlementsApi->entitlements_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str
repo	str
data	RepositoryTokenRequest		[optional]
show_tokens	bool	Show entitlement token strings in results	[optional] [default to false]

Return type

RepositoryToken

Authorization

apikey, basic

HTTP request headers

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

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

entitlements_delete

entitlements_delete(owner, repo, identifier)

Delete a specific entitlement in a repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.EntitlementsApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
identifier = 'identifier_example' # str | 

try:
    # Delete a specific entitlement in a repository.
    api_instance.entitlements_delete(owner, repo, identifier)
except ApiException as e:
    print("Exception when calling EntitlementsApi->entitlements_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str
repo	str
identifier	str

Return type

void (empty response body)

Authorization

apikey, basic

HTTP request headers

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

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

entitlements_disable

entitlements_disable(owner, repo, identifier)

Disable an entitlement token in a repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.EntitlementsApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
identifier = 'identifier_example' # str | 

try:
    # Disable an entitlement token in a repository.
    api_instance.entitlements_disable(owner, repo, identifier)
except ApiException as e:
    print("Exception when calling EntitlementsApi->entitlements_disable: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str
repo	str
identifier	str

Return type

void (empty response body)

Authorization

apikey, basic

HTTP request headers

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

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

entitlements_enable

entitlements_enable(owner, repo, identifier)

Enable an entitlement token in a repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.EntitlementsApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
identifier = 'identifier_example' # str | 

try:
    # Enable an entitlement token in a repository.
    api_instance.entitlements_enable(owner, repo, identifier)
except ApiException as e:
    print("Exception when calling EntitlementsApi->entitlements_enable: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str
repo	str
identifier	str

Return type

void (empty response body)

Authorization

apikey, basic

HTTP request headers

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

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

entitlements_list

list[RepositoryToken] entitlements_list(owner, repo, page=page, page_size=page_size, show_tokens=show_tokens, query=query, active=active, exclude_other_user_tokens=exclude_other_user_tokens, sort=sort)

Get a list of all entitlements in a repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.EntitlementsApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
page = 56 # int | A page number within the paginated result set. (optional)
page_size = 56 # int | Number of results to return per page. (optional)
show_tokens = false # bool | Show entitlement token strings in results (optional) (default to false)
query = 'query_example' # str | A search term for querying names of entitlements. (optional)
active = false # bool | If true, only include active tokens (optional) (default to false)
exclude_other_user_tokens = false # bool | If true, exclude user tokens that belong to other users (optional) (default to false)
sort = 'name' # str | A field for sorting objects in ascending or descending order. Use `-` prefix for descending order (e.g., `-name`). Available options: name. (optional) (default to name)

try:
    # Get a list of all entitlements in a repository.
    api_response = api_instance.entitlements_list(owner, repo, page=page, page_size=page_size, show_tokens=show_tokens, query=query, active=active, exclude_other_user_tokens=exclude_other_user_tokens, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitlementsApi->entitlements_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str
repo	str
page	int	A page number within the paginated result set.	[optional]
page_size	int	Number of results to return per page.	[optional]
show_tokens	bool	Show entitlement token strings in results	[optional] [default to false]
query	str	A search term for querying names of entitlements.	[optional]
active	bool	If true, only include active tokens	[optional] [default to false]
exclude_other_user_tokens	bool	If true, exclude user tokens that belong to other users	[optional] [default to false]
sort	str	A field for sorting objects in ascending or descending order. Use `-` prefix for descending order (e.g., `-name`). Available options: name.	[optional] [default to name]

Return type

list[RepositoryToken]

Authorization

apikey, basic

HTTP request headers

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

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

entitlements_partial_update

RepositoryToken entitlements_partial_update(owner, repo, identifier, data=data, show_tokens=show_tokens)

Update a specific entitlement in a repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.EntitlementsApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
identifier = 'identifier_example' # str | 
data = cloudsmith_api.RepositoryTokenRequestPatch() # RepositoryTokenRequestPatch |  (optional)
show_tokens = false # bool | Show entitlement token strings in results (optional) (default to false)

try:
    # Update a specific entitlement in a repository.
    api_response = api_instance.entitlements_partial_update(owner, repo, identifier, data=data, show_tokens=show_tokens)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitlementsApi->entitlements_partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str
repo	str
identifier	str
data	RepositoryTokenRequestPatch		[optional]
show_tokens	bool	Show entitlement token strings in results	[optional] [default to false]

Return type

RepositoryToken

Authorization

apikey, basic

HTTP request headers

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

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

entitlements_read

RepositoryToken entitlements_read(owner, repo, identifier, fuzzy=fuzzy, show_tokens=show_tokens)

Get a specific entitlement in a repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.EntitlementsApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
identifier = 'identifier_example' # str | 
fuzzy = false # bool | If true, entitlement identifiers including name will be fuzzy matched. (optional) (default to false)
show_tokens = false # bool | Show entitlement token strings in results (optional) (default to false)

try:
    # Get a specific entitlement in a repository.
    api_response = api_instance.entitlements_read(owner, repo, identifier, fuzzy=fuzzy, show_tokens=show_tokens)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitlementsApi->entitlements_read: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str
repo	str
identifier	str
fuzzy	bool	If true, entitlement identifiers including name will be fuzzy matched.	[optional] [default to false]
show_tokens	bool	Show entitlement token strings in results	[optional] [default to false]

Return type

RepositoryToken

Authorization

apikey, basic

HTTP request headers

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

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

entitlements_refresh

RepositoryTokenRefresh entitlements_refresh(owner, repo, identifier, data=data, show_tokens=show_tokens)

Refresh an entitlement token in a repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.EntitlementsApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
identifier = 'identifier_example' # str | 
data = cloudsmith_api.RepositoryTokenRefreshRequest() # RepositoryTokenRefreshRequest |  (optional)
show_tokens = false # bool | Show entitlement token strings in results (optional) (default to false)

try:
    # Refresh an entitlement token in a repository.
    api_response = api_instance.entitlements_refresh(owner, repo, identifier, data=data, show_tokens=show_tokens)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitlementsApi->entitlements_refresh: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str
repo	str
identifier	str
data	RepositoryTokenRefreshRequest		[optional]
show_tokens	bool	Show entitlement token strings in results	[optional] [default to false]

Return type

RepositoryTokenRefresh

Authorization

apikey, basic

HTTP request headers

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

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

entitlements_reset

entitlements_reset(owner, repo, identifier, show_tokens=show_tokens)

Reset the statistics for an entitlement token in a repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.EntitlementsApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
identifier = 'identifier_example' # str | 
show_tokens = false # bool | Show entitlement token strings in results (optional) (default to false)

try:
    # Reset the statistics for an entitlement token in a repository.
    api_instance.entitlements_reset(owner, repo, identifier, show_tokens=show_tokens)
except ApiException as e:
    print("Exception when calling EntitlementsApi->entitlements_reset: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str
repo	str
identifier	str
show_tokens	bool	Show entitlement token strings in results	[optional] [default to false]

Return type

void (empty response body)

Authorization

apikey, basic

HTTP request headers

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

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

entitlements_sync

RepositoryTokenSync entitlements_sync(owner, repo, data=data, show_tokens=show_tokens)

Synchronise tokens from a source repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.EntitlementsApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
data = cloudsmith_api.RepositoryTokenSyncRequest() # RepositoryTokenSyncRequest |  (optional)
show_tokens = false # bool | Show entitlement token strings in results (optional) (default to false)

try:
    # Synchronise tokens from a source repository.
    api_response = api_instance.entitlements_sync(owner, repo, data=data, show_tokens=show_tokens)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitlementsApi->entitlements_sync: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str
repo	str
data	RepositoryTokenSyncRequest		[optional]
show_tokens	bool	Show entitlement token strings in results	[optional] [default to false]

Return type

RepositoryTokenSync

Authorization

apikey, basic

HTTP request headers

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

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

entitlements_toggle_private_broadcasts

entitlements_toggle_private_broadcasts(owner, repo, identifier, data=data)

Set private broadcast access for an entitlement token in a repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.EntitlementsApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
identifier = 'identifier_example' # str | 
data = cloudsmith_api.RepositoryTokenPrivateBroadcastsRequest() # RepositoryTokenPrivateBroadcastsRequest |  (optional)

try:
    # Set private broadcast access for an entitlement token in a repository.
    api_instance.entitlements_toggle_private_broadcasts(owner, repo, identifier, data=data)
except ApiException as e:
    print("Exception when calling EntitlementsApi->entitlements_toggle_private_broadcasts: %s\n" % e)

Parameters

Name	Type	Notes
owner	str
repo	str
identifier	str
data	RepositoryTokenPrivateBroadcastsRequest	[optional]

Return type

void (empty response body)

Authorization

apikey, basic

HTTP request headers

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

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

FilesExpand file tree

EntitlementsApi.md

Latest commit

History

EntitlementsApi.md

File metadata and controls

cloudsmith_api.EntitlementsApi

entitlements_create

Example

Parameters

Return type

Authorization

HTTP request headers

entitlements_delete

Example

Parameters

Return type

Authorization

HTTP request headers

entitlements_disable

Example

Parameters

Return type

Authorization

HTTP request headers

entitlements_enable

Example

Parameters

Return type

Authorization

HTTP request headers

entitlements_list

Example

Parameters

Return type

Authorization

HTTP request headers

entitlements_partial_update

Example

Parameters

Return type

Authorization

HTTP request headers

entitlements_read

Example

Parameters

Return type

Authorization

HTTP request headers

entitlements_refresh

Example

Parameters

Return type

Authorization

HTTP request headers

entitlements_reset

Example

Parameters

Return type

Authorization

HTTP request headers

entitlements_sync

Example

Parameters

Return type

Authorization

HTTP request headers

entitlements_toggle_private_broadcasts

Example

Parameters

Return type

Authorization

HTTP request headers