ExternalAuthenticationCreateLoginTokenRequest

Bases: OCIRequest

This command allows a BroadWorks or Third-Party Client Application to create a Single Sign-On token for a user. The response is either ExternalAuthenticationCreateLoginTokenResponse or ErrorResponse.

Attributes:

user_id (str):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class ExternalAuthenticationCreateLoginTokenRequest(OCIRequest):
    """This command allows a BroadWorks or Third-Party Client Application to
        create a Single Sign-On token for a user.
        The response is either ExternalAuthenticationCreateLoginTokenResponse
        or ErrorResponse.

    Attributes:

        user_id (str):

    """

    user_id: str = field(metadata={"alias": "userId"})

Responses

Bases: OCIDataResponse

Response to ExternalAuthenticationCreateLoginTokenRequest.

Attributes:

login_token (str):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class ExternalAuthenticationCreateLoginTokenResponse(OCIDataResponse):
    """Response to ExternalAuthenticationCreateLoginTokenRequest.

    Attributes:

        login_token (str):

    """

    login_token: str = field(metadata={"alias": "loginToken"})

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import ExternalAuthenticationCreateLoginTokenRequest

client = Client()

command = ExternalAuthenticationCreateLoginTokenRequest(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("ExternalAuthenticationCreateLoginTokenRequest",
    user_id=...,
)

print(response)