README.md

LinkedUsers

(linked_users)

Available Operations

• create - Create Linked Users
• list - List Linked Users
• import_batch - Add Batch Linked Users
• retrieve - Retrieve Linked Users
• remote_id - Retrieve a Linked User From A Remote Id

create

Create Linked Users

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.linked_users.create(request={
    "linked_user_origin_id": "id_1",
    "alias": "acme",
})

if res is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	models.CreateLinkedUserDto	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.LinkedUserResponse

Errors

Error Object	Status Code	Content Type
models.SDKError	4xx-5xx	/

list

List Linked Users

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.linked_users.list()

if res is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

List[models.LinkedUserResponse]

Errors

Error Object	Status Code	Content Type
models.SDKError	4xx-5xx	/

import_batch

Add Batch Linked Users

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.linked_users.import_batch(request={
    "linked_user_origin_ids": [
        "id_1",
    ],
    "alias": "acme",
})

if res is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	models.CreateBatchLinkedUserDto	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

List[models.LinkedUserResponse]

Errors

Error Object	Status Code	Content Type
models.SDKError	4xx-5xx	/

retrieve

Retrieve Linked Users

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.linked_users.retrieve(id="801f9ede-c698-4e66-a7fc-48d19eebaa4f")

if res is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description	Example
id	str	✔️	N/A	801f9ede-c698-4e66-a7fc-48d19eebaa4f
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.LinkedUserResponse

Errors

Error Object	Status Code	Content Type
models.SDKError	4xx-5xx	/

remote_id

Retrieve a Linked User From A Remote Id

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.linked_users.remote_id(remote_id="id_1")

if res is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description	Example
remote_id	str	✔️	N/A	id_1
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.LinkedUserResponse

Errors

Error Object	Status Code	Content Type
models.SDKError	4xx-5xx	/