Class: AWS.SSOOIDC

Inherits:
AWS.Service show all
Identifier:
ssooidc
API Version:
2019-06-10
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client (such as AWS CLI or a native application) to register with AWS SSO. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of the device authorization grant standard (https://tools.ietf.org/html/rfc8628).

For general information about AWS SSO, see What is AWS Single Sign-On? in the AWS SSO User Guide.

This API reference guide describes the AWS SSO OIDC operations that you can call programatically and includes detailed information on data types and errors.

Note: AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a convenient way to create programmatic access to AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

Sending a Request Using SSOOIDC

var ssooidc = new AWS.SSOOIDC();
ssooidc.createToken(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SSOOIDC object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var ssooidc = new AWS.SSOOIDC({apiVersion: '2019-06-10'});

You can also set the API version globally in AWS.config.apiVersions using the ssooidc service identifier:

AWS.config.apiVersions = {
  ssooidc: '2019-06-10',
  // other service API versions
};

var ssooidc = new AWS.SSOOIDC();

Version:

  • 2019-06-10

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.SSOOIDC(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a SSOOIDC object

var ssooidc = new AWS.SSOOIDC({apiVersion: '2019-06-10'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.SSOOIDC.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.SSOOIDC.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.SSOOIDC.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createToken(params = {}, callback) ⇒ AWS.Request

Creates and returns an access token for the authorized client. The access token issued will be used to fetch short-term credentials for the assigned roles in the AWS account.

Service Reference:

Examples:

Calling the createToken operation

var params = {
  clientId: 'STRING_VALUE', /* required */
  clientSecret: 'STRING_VALUE', /* required */
  deviceCode: 'STRING_VALUE', /* required */
  grantType: 'STRING_VALUE', /* required */
  code: 'STRING_VALUE',
  redirectUri: 'STRING_VALUE',
  refreshToken: 'STRING_VALUE',
  scope: [
    'STRING_VALUE',
    /* more items */
  ]
};
ssooidc.createToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientId — (String)

      The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.

    • clientSecret — (String)

      A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

    • grantType — (String)

      Supports grant types for authorization code, refresh token, and device code request.

    • deviceCode — (String)

      Used only when calling this API for the device code grant type. This short-term code is used to identify this authentication attempt. This should come from an in-memory reference to the result of the StartDeviceAuthorization API.

    • code — (String)

      The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.

    • refreshToken — (String)

      The token used to obtain an access token in the event that the access token is invalid or expired. This token is not issued by the service.

    • scope — (Array<String>)

      The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

    • redirectUri — (String)

      The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accessToken — (String)

        An opaque token to access AWS SSO resources assigned to a user.

      • tokenType — (String)

        Used to notify the client that the returned token is an access token. The supported type is BearerToken.

      • expiresIn — (Integer)

        Indicates the time in seconds when an access token will expire.

      • refreshToken — (String)

        A token that, if present, can be used to refresh a previously issued access token that might have expired.

      • idToken — (String)

        The identifier of the user that associated with the access token, if present.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

registerClient(params = {}, callback) ⇒ AWS.Request

Registers a client with AWS SSO. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.

Service Reference:

Examples:

Calling the registerClient operation

var params = {
  clientName: 'STRING_VALUE', /* required */
  clientType: 'STRING_VALUE', /* required */
  scopes: [
    'STRING_VALUE',
    /* more items */
  ]
};
ssooidc.registerClient(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientName — (String)

      The friendly name of the client.

    • clientType — (String)

      The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.

    • scopes — (Array<String>)

      The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • clientId — (String)

        The unique identifier string for each client. This client uses this identifier to get authenticated by the service in subsequent calls.

      • clientSecret — (String)

        A secret string generated for the client. The client will use this string to get authenticated by the service in subsequent calls.

      • clientIdIssuedAt — (Integer)

        Indicates the time at which the clientId and clientSecret were issued.

      • clientSecretExpiresAt — (Integer)

        Indicates the time at which the clientId and clientSecret will become invalid.

      • authorizationEndpoint — (String)

        The endpoint where the client can request authorization.

      • tokenEndpoint — (String)

        The endpoint where the client can get an access token.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startDeviceAuthorization(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startDeviceAuthorization operation

var params = {
  clientId: 'STRING_VALUE', /* required */
  clientSecret: 'STRING_VALUE', /* required */
  startUrl: 'STRING_VALUE' /* required */
};
ssooidc.startDeviceAuthorization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientId — (String)

      The unique identifier string for the client that is registered with AWS SSO. This value should come from the persisted result of the RegisterClient API operation.

    • clientSecret — (String)

      A secret string that is generated for the client. This value should come from the persisted result of the RegisterClient API operation.

    • startUrl — (String)

      The URL for the AWS SSO user portal. For more information, see Using the User Portal in the AWS Single Sign-On User Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • deviceCode — (String)

        The short-lived code that is used by the device when polling for a session token.

      • userCode — (String)

        A one-time user verification code. This is needed to authorize an in-use device.

      • verificationUri — (String)

        The URI of the verification page that takes the userCode to authorize the device.

      • verificationUriComplete — (String)

        An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.

      • expiresIn — (Integer)

        Indicates the number of seconds in which the verification code will become invalid.

      • interval — (Integer)

        Indicates the number of seconds the client must wait between attempts when polling for a session.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.