jcapiv1.SystemusersApi

All URIs are relative to https://console.jumpcloud.com/api

Method	HTTP request	Description
sshkey_delete	DELETE /systemusers/{systemuser_id}/sshkeys/{id}	Delete a system user's Public SSH Keys
sshkey_list	GET /systemusers/{id}/sshkeys	List a system user's public SSH keys
sshkey_post	POST /systemusers/{id}/sshkeys	Create a system user's Public SSH Key
systemusers_delete	DELETE /systemusers/{id}	Delete a system user
systemusers_get	GET /systemusers/{id}	List a system user
systemusers_list	GET /systemusers	List all system users
systemusers_post	POST /systemusers	Create a system user
systemusers_put	PUT /systemusers/{id}	Update a system user
systemusers_resetmfa	POST /systemusers/{id}/resetmfa	Reset a system user's MFA token
systemusers_systems_binding_list	GET /systemusers/{id}/systems	List system user binding
systemusers_systems_binding_put	PUT /systemusers/{id}/systems	Update a system user binding
systemusers_unlock	POST /systemusers/{id}/unlock	Unlock a system user

sshkey_delete

sshkey_delete(systemuser_id, id, content_type, accept, x_org_id=x_org_id)

Delete a system user's Public SSH Keys

This endpoint will delete a specific System User's SSH Key.

Example

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

# Configure API key authorization: x-api-key
configuration = jcapiv1.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'

# create an instance of the API class
api_instance = jcapiv1.SystemusersApi(jcapiv1.ApiClient(configuration))
systemuser_id = 'systemuser_id_example' # str | 
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
x_org_id = '' # str |  (optional) (default to )

try:
    # Delete a system user's Public SSH Keys
    api_instance.sshkey_delete(systemuser_id, id, content_type, accept, x_org_id=x_org_id)
except ApiException as e:
    print("Exception when calling SystemusersApi->sshkey_delete: %s\n" % e)

Parameters

Name	Type	Notes
systemuser_id	str
id	str
content_type	str	[default to application/json]
accept	str	[default to application/json]
x_org_id	str	[optional] [default to ]

Return type

void (empty response body)

Authorization

x-api-key

HTTP request headers

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

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

sshkey_list

list[Sshkeylist] sshkey_list(id, content_type, accept, x_org_id=x_org_id)

List a system user's public SSH keys

This endpoint will return a specific System User's public SSH key.

Example

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

# Configure API key authorization: x-api-key
configuration = jcapiv1.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'

# create an instance of the API class
api_instance = jcapiv1.SystemusersApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
x_org_id = '' # str |  (optional) (default to )

try:
    # List a system user's public SSH keys
    api_response = api_instance.sshkey_list(id, content_type, accept, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemusersApi->sshkey_list: %s\n" % e)

Parameters

Name	Type	Notes
id	str
content_type	str	[default to application/json]
accept	str	[default to application/json]
x_org_id	str	[optional] [default to ]

Return type

list[Sshkeylist]

Authorization

x-api-key

HTTP request headers

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

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

sshkey_post

Sshkeylist sshkey_post(id, content_type, accept, body=body, x_org_id=x_org_id)

Create a system user's Public SSH Key

This endpoint will create a specific System User's Public SSH Key.

Example

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

# Configure API key authorization: x-api-key
configuration = jcapiv1.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'

# create an instance of the API class
api_instance = jcapiv1.SystemusersApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
body = jcapiv1.Sshkeypost() # Sshkeypost |  (optional)
x_org_id = '' # str |  (optional) (default to )

try:
    # Create a system user's Public SSH Key
    api_response = api_instance.sshkey_post(id, content_type, accept, body=body, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemusersApi->sshkey_post: %s\n" % e)

Parameters

Name	Type	Notes
id	str
content_type	str	[default to application/json]
accept	str	[default to application/json]
body	Sshkeypost	[optional]
x_org_id	str	[optional] [default to ]

Return type

Sshkeylist

Authorization

x-api-key

HTTP request headers

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

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

systemusers_delete

Systemuserreturn systemusers_delete(id, content_type, accept, x_org_id=x_org_id)

Delete a system user

This endpoint allows you to delete a particular system user. #### Sample Request curl -X DELETE https://console.jumpcloud.com/api/systemusers/{UserID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

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

# Configure API key authorization: x-api-key
configuration = jcapiv1.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'

# create an instance of the API class
api_instance = jcapiv1.SystemusersApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
x_org_id = '' # str |  (optional) (default to )

try:
    # Delete a system user
    api_response = api_instance.systemusers_delete(id, content_type, accept, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemusersApi->systemusers_delete: %s\n" % e)

Parameters

Name	Type	Notes
id	str
content_type	str	[default to application/json]
accept	str	[default to application/json]
x_org_id	str	[optional] [default to ]

Return type

Systemuserreturn

Authorization

x-api-key

HTTP request headers

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

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

systemusers_get

Systemuserreturn systemusers_get(id, content_type, accept, fields=fields, filter=filter, x_org_id=x_org_id)

List a system user

This endpoint returns a particular System User. #### Sample Request curl -X GET https://console.jumpcloud.com/api/systemusers/{UserID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

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

# Configure API key authorization: x-api-key
configuration = jcapiv1.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'

# create an instance of the API class
api_instance = jcapiv1.SystemusersApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
fields = '' # str | Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.  (optional) (default to )
filter = 'filter_example' # str | A filter to apply to the query. (optional)
x_org_id = '' # str |  (optional) (default to )

try:
    # List a system user
    api_response = api_instance.systemusers_get(id, content_type, accept, fields=fields, filter=filter, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemusersApi->systemusers_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
content_type	str		[default to application/json]
accept	str		[default to application/json]
fields	str	Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.	[optional] [default to ]
filter	str	A filter to apply to the query.	[optional]
x_org_id	str		[optional] [default to ]

Return type

Systemuserreturn

Authorization

x-api-key

HTTP request headers

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

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

systemusers_list

Systemuserslist systemusers_list(content_type, accept, limit=limit, skip=skip, sort=sort, fields=fields, x_org_id=x_org_id, search=search, filter=filter)

List all system users

This endpoint returns all systemusers. #### Sample Request curl -X GET https://console.jumpcloud.com/api/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

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

# Configure API key authorization: x-api-key
configuration = jcapiv1.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'

# create an instance of the API class
api_instance = jcapiv1.SystemusersApi(jcapiv1.ApiClient(configuration))
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
limit = 10 # int | The number of records to return at once. (optional) (default to 10)
skip = 0 # int | The offset into the records to return. (optional) (default to 0)
sort = '' # str | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.  (optional) (default to )
fields = '' # str | The comma separated fields included in the returned records. If omitted the default list of fields will be returned.  (optional) (default to )
x_org_id = '' # str |  (optional) (default to )
search = 'search_example' # str | A nested object containing a string `searchTerm` and a list of `fields` to search on. (optional)
filter = 'filter_example' # str | A filter to apply to the query. (optional)

try:
    # List all system users
    api_response = api_instance.systemusers_list(content_type, accept, limit=limit, skip=skip, sort=sort, fields=fields, x_org_id=x_org_id, search=search, filter=filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemusersApi->systemusers_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
content_type	str		[default to application/json]
accept	str		[default to application/json]
limit	int	The number of records to return at once.	[optional] [default to 10]
skip	int	The offset into the records to return.	[optional] [default to 0]
sort	str	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.	[optional] [default to ]
fields	str	The comma separated fields included in the returned records. If omitted the default list of fields will be returned.	[optional] [default to ]
x_org_id	str		[optional] [default to ]
search	str	A nested object containing a string `searchTerm` and a list of `fields` to search on.	[optional]
filter	str	A filter to apply to the query.	[optional]

Return type

Systemuserslist

Authorization

x-api-key

HTTP request headers

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

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

systemusers_post

Systemuserreturn systemusers_post(content_type, accept, body=body, x_org_id=x_org_id)

Create a system user

This endpoint allows you to create a new system user. #### Sample Request curl -X POST https://console.jumpcloud.com/api/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"username\":\"{username}\", \"email\":\"{email_address}\", \"firstname\":\"{Name}\", \"lastname\":\"{Name}\" }'

Example

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

# Configure API key authorization: x-api-key
configuration = jcapiv1.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'

# create an instance of the API class
api_instance = jcapiv1.SystemusersApi(jcapiv1.ApiClient(configuration))
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
body = jcapiv1.Systemuserputpost() # Systemuserputpost |  (optional)
x_org_id = '' # str |  (optional) (default to )

try:
    # Create a system user
    api_response = api_instance.systemusers_post(content_type, accept, body=body, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemusersApi->systemusers_post: %s\n" % e)

Parameters

Name	Type	Notes
content_type	str	[default to application/json]
accept	str	[default to application/json]
body	Systemuserputpost	[optional]
x_org_id	str	[optional] [default to ]

Return type

Systemuserreturn

Authorization

x-api-key

HTTP request headers

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

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

systemusers_put

Systemuserreturn systemusers_put(id, content_type, accept, body=body, x_org_id=x_org_id)

Update a system user

This endpoint allows you to update a system user. #### Sample Request curl -X PUT https://console.jumpcloud.com/api/systemusers/{UserID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"email\":\"{email_address}\", \"firstname\":\"{Name}\", \"lastname\":\"{Name}\" }'

Example

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

# Configure API key authorization: x-api-key
configuration = jcapiv1.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'

# create an instance of the API class
api_instance = jcapiv1.SystemusersApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
body = jcapiv1.Systemuserput() # Systemuserput |  (optional)
x_org_id = '' # str |  (optional) (default to )

try:
    # Update a system user
    api_response = api_instance.systemusers_put(id, content_type, accept, body=body, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemusersApi->systemusers_put: %s\n" % e)

Parameters

Name	Type	Notes
id	str
content_type	str	[default to application/json]
accept	str	[default to application/json]
body	Systemuserput	[optional]
x_org_id	str	[optional] [default to ]

Return type

Systemuserreturn

Authorization

x-api-key

HTTP request headers

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

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

systemusers_resetmfa

systemusers_resetmfa(id, content_type, accept, body=body, x_org_id=x_org_id)

Reset a system user's MFA token

This endpoint allows you to reset the TOTP key for a specified system user and put them in an TOTP MFA enrollment period. This will result in the user being prompted to setup TOTP MFA when logging into userportal. Please be aware that if the user does not complete TOTP MFA setup before the exclusionUntil date, they will be locked out of any resources that require TOTP MFA. Please refer to our Knowledge Base Article on setting up MFA for more information. #### Sample Request curl -X POST \\ https://console.jumpcloud.com/api/systemusers/{UserID}/resetmfa \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{\"exclusion\": true, \"exclusionUntil\": \"{date-time}\"}'

Example

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

# Configure API key authorization: x-api-key
configuration = jcapiv1.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'

# create an instance of the API class
api_instance = jcapiv1.SystemusersApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
body = jcapiv1.Body1() # Body1 |  (optional)
x_org_id = '' # str |  (optional) (default to )

try:
    # Reset a system user's MFA token
    api_instance.systemusers_resetmfa(id, content_type, accept, body=body, x_org_id=x_org_id)
except ApiException as e:
    print("Exception when calling SystemusersApi->systemusers_resetmfa: %s\n" % e)

Parameters

Name	Type	Notes
id	str
content_type	str	[default to application/json]
accept	str	[default to application/json]
body	Body1	[optional]
x_org_id	str	[optional] [default to ]

Return type

void (empty response body)

Authorization

x-api-key

HTTP request headers

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

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

systemusers_systems_binding_list

object systemusers_systems_binding_list(id, content_type, accept, fields=fields, limit=limit, skip=skip, sort=sort, filter=filter, x_org_id=x_org_id)

List system user binding

Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found here. List system bindings for a specific system user in a system and user binding format. ### Examples #### List system bindings for specific system user curl \\ -H 'Content-Type: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\"

Example

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

# Configure API key authorization: x-api-key
configuration = jcapiv1.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'

# create an instance of the API class
api_instance = jcapiv1.SystemusersApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
fields = '' # str | Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.  (optional) (default to )
limit = 10 # int | The number of records to return at once. Limited to 100. (optional) (default to 10)
skip = 0 # int | The offset into the records to return. (optional) (default to 0)
sort = '' # str | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.  (optional) (default to )
filter = 'filter_example' # str | A filter to apply to the query. (optional)
x_org_id = '' # str |  (optional) (default to )

try:
    # List system user binding
    api_response = api_instance.systemusers_systems_binding_list(id, content_type, accept, fields=fields, limit=limit, skip=skip, sort=sort, filter=filter, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemusersApi->systemusers_systems_binding_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
content_type	str		[default to application/json]
accept	str		[default to application/json]
fields	str	Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.	[optional] [default to ]
limit	int	The number of records to return at once. Limited to 100.	[optional] [default to 10]
skip	int	The offset into the records to return.	[optional] [default to 0]
sort	str	Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.	[optional] [default to ]
filter	str	A filter to apply to the query.	[optional]
x_org_id	str		[optional] [default to ]

Return type

object

Authorization

x-api-key

HTTP request headers

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

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

systemusers_systems_binding_put

Usersystembinding systemusers_systems_binding_put(id, content_type, accept, body=body, x_org_id=x_org_id)

Update a system user binding

Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found here. ### Example #### Add (or remove) system to system user curl \\ -d '{ \"add\": [\"[SYSTEM_ID_TO_ADD_HERE]\"], \"remove\": [\"[SYSTEM_ID_TO_REMOVE_HERE]\"] }' \\ -X PUT \\ -H 'Content-Type: application/json' \\ -H 'Accept: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\"

Example

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

# Configure API key authorization: x-api-key
configuration = jcapiv1.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'

# create an instance of the API class
api_instance = jcapiv1.SystemusersApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
body = jcapiv1.Usersystembindingsput() # Usersystembindingsput |  (optional)
x_org_id = '' # str |  (optional) (default to )

try:
    # Update a system user binding
    api_response = api_instance.systemusers_systems_binding_put(id, content_type, accept, body=body, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemusersApi->systemusers_systems_binding_put: %s\n" % e)

Parameters

Name	Type	Notes
id	str
content_type	str	[default to application/json]
accept	str	[default to application/json]
body	Usersystembindingsput	[optional]
x_org_id	str	[optional] [default to ]

Return type

Usersystembinding

Authorization

x-api-key

HTTP request headers

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

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

systemusers_unlock

systemusers_unlock(id, content_type, accept, x_org_id=x_org_id)

Unlock a system user

This endpoint allows you to unlock a user's account.

Example

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

# Configure API key authorization: x-api-key
configuration = jcapiv1.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'

# create an instance of the API class
api_instance = jcapiv1.SystemusersApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
x_org_id = '' # str |  (optional) (default to )

try:
    # Unlock a system user
    api_instance.systemusers_unlock(id, content_type, accept, x_org_id=x_org_id)
except ApiException as e:
    print("Exception when calling SystemusersApi->systemusers_unlock: %s\n" % e)

Parameters

Name	Type	Notes
id	str
content_type	str	[default to application/json]
accept	str	[default to application/json]
x_org_id	str	[optional] [default to ]

Return type

void (empty response body)

Authorization

x-api-key

HTTP request headers

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

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

Files

SystemusersApi.md

Latest commit

History

SystemusersApi.md

File metadata and controls

jcapiv1.SystemusersApi

sshkey_delete

Example

Parameters

Return type

Authorization

HTTP request headers

sshkey_list

Example

Parameters

Return type

Authorization

HTTP request headers

sshkey_post

Example

Parameters

Return type

Authorization

HTTP request headers

systemusers_delete

Example

Parameters

Return type

Authorization

HTTP request headers

systemusers_get

Example

Parameters

Return type

Authorization

HTTP request headers

systemusers_list

Example

Parameters

Return type

Authorization

HTTP request headers

systemusers_post

Example

Parameters

Return type

Authorization

HTTP request headers

systemusers_put

Example

Parameters

Return type

Authorization

HTTP request headers

systemusers_resetmfa

Example

Parameters

Return type

Authorization

HTTP request headers

systemusers_systems_binding_list

Example

Parameters

Return type

Authorization

HTTP request headers

systemusers_systems_binding_put

Example

Parameters

Return type

Authorization

HTTP request headers

systemusers_unlock

Example

Parameters

Return type

Authorization

HTTP request headers