Skip to content

Generates a temporary authorization token for accessing repositories in the domain

Description

Generates a temporary authorization token for accessing repositories in the domain. This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken permissions. For more information about authorization tokens, see CodeArtifact authentication and tokens.

CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. You can call login periodically to refresh the token. When you create an authorization token with the get_authorization_token API, you can set a custom authorization period, up to a maximum of 12 hours, with the durationSeconds parameter.

The authorization period begins after login or get_authorization_token is called. If login or get_authorization_token is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes, then generate a CodeArtifact authorization token, the token will be valid for the full authorization period even though this is longer than the 15-minute session duration.

See Using IAM Roles for more information on controlling session duration.

Usage

codeartifact_get_authorization_token(domain, domainOwner,
  durationSeconds)

Arguments

  • domain

    [required] The name of the domain that is in scope for the generated authorization token.

  • domainOwner

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • durationSeconds

    The time, in seconds, that the generated authorization token is valid. Valid values are 0 and any number between 900 (15 minutes) and 43200 (12 hours). A value of 0 will set the expiration of the authorization token to the same expiration of the user's role's temporary credentials.

Value

A list with the following syntax:

list(
  authorizationToken = "string",
  expiration = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$get_authorization_token(
  domain = "string",
  domainOwner = "string",
  durationSeconds = 123
)