SSOOIDCClient#

Index > SSOOIDC > SSOOIDCClient

Auto-generated documentation for SSOOIDC type annotations stubs module types-boto3-sso-oidc.

SSOOIDCClient#

Type annotations and code completion for boto3.client("sso-oidc"). boto3 documentation

# SSOOIDCClient usage example

from boto3.session import Session
from types_boto3_sso_oidc.client import SSOOIDCClient

def get_sso-oidc_client() -> SSOOIDCClient:
    return Session().client("sso-oidc")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("sso-oidc").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("sso-oidc")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.AuthorizationPendingException,
    client.exceptions.ClientError,
    client.exceptions.ExpiredTokenException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidClientException,
    client.exceptions.InvalidClientMetadataException,
    client.exceptions.InvalidGrantException,
    client.exceptions.InvalidRedirectUriException,
    client.exceptions.InvalidRequestException,
    client.exceptions.InvalidRequestRegionException,
    client.exceptions.InvalidScopeException,
    client.exceptions.SlowDownException,
    client.exceptions.UnauthorizedClientException,
    client.exceptions.UnsupportedGrantTypeException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_sso_oidc.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("sso-oidc").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("sso-oidc").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_token#

Creates and returns access and refresh tokens for clients that are authenticated using client secrets.

Type annotations and code completion for boto3.client("sso-oidc").create_token method. boto3 documentation

# create_token method definition

def create_token(
    self,
    *,
    clientId: str,
    clientSecret: str,
    grantType: str,
    deviceCode: str = ...,
    code: str = ...,
    refreshToken: str = ...,
    scope: Sequence[str] = ...,
    redirectUri: str = ...,
    codeVerifier: str = ...,
) -> CreateTokenResponseTypeDef:  # (1)
    ...

See CreateTokenResponseTypeDef

# create_token method usage example with argument unpacking

kwargs: CreateTokenRequestTypeDef = {  # (1)
    "clientId": ...,
    "clientSecret": ...,
    "grantType": ...,
}

parent.create_token(**kwargs)

See CreateTokenRequestTypeDef

create_token_with_iam#

Creates and returns access and refresh tokens for authorized client applications that are authenticated using any IAM entity, such as a service role or user.

Type annotations and code completion for boto3.client("sso-oidc").create_token_with_iam method. boto3 documentation

# create_token_with_iam method definition

def create_token_with_iam(
    self,
    *,
    clientId: str,
    grantType: str,
    code: str = ...,
    refreshToken: str = ...,
    assertion: str = ...,
    scope: Sequence[str] = ...,
    redirectUri: str = ...,
    subjectToken: str = ...,
    subjectTokenType: str = ...,
    requestedTokenType: str = ...,
    codeVerifier: str = ...,
) -> CreateTokenWithIAMResponseTypeDef:  # (1)
    ...

See CreateTokenWithIAMResponseTypeDef

# create_token_with_iam method usage example with argument unpacking

kwargs: CreateTokenWithIAMRequestTypeDef = {  # (1)
    "clientId": ...,
    "grantType": ...,
}

parent.create_token_with_iam(**kwargs)

See CreateTokenWithIAMRequestTypeDef

register_client#

Registers a public client with IAM Identity Center.

Type annotations and code completion for boto3.client("sso-oidc").register_client method. boto3 documentation

# register_client method definition

def register_client(
    self,
    *,
    clientName: str,
    clientType: str,
    scopes: Sequence[str] = ...,
    redirectUris: Sequence[str] = ...,
    grantTypes: Sequence[str] = ...,
    issuerUrl: str = ...,
    entitledApplicationArn: str = ...,
) -> RegisterClientResponseTypeDef:  # (1)
    ...

See RegisterClientResponseTypeDef

# register_client method usage example with argument unpacking

kwargs: RegisterClientRequestTypeDef = {  # (1)
    "clientName": ...,
    "clientType": ...,
}

parent.register_client(**kwargs)

See RegisterClientRequestTypeDef

start_device_authorization#

Initiates device authorization by requesting a pair of verification codes from the authorization service.

Type annotations and code completion for boto3.client("sso-oidc").start_device_authorization method. boto3 documentation

# start_device_authorization method definition

def start_device_authorization(
    self,
    *,
    clientId: str,
    clientSecret: str,
    startUrl: str,
) -> StartDeviceAuthorizationResponseTypeDef:  # (1)
    ...

See StartDeviceAuthorizationResponseTypeDef

# start_device_authorization method usage example with argument unpacking

kwargs: StartDeviceAuthorizationRequestTypeDef = {  # (1)
    "clientId": ...,
    "clientSecret": ...,
    "startUrl": ...,
}

parent.start_device_authorization(**kwargs)

See StartDeviceAuthorizationRequestTypeDef