signJwt method

  1. @Deprecated('Not supported. Member documentation may have more information.')
Future<SignJwtResponse> signJwt(
  1. SignJwtRequest request,
  2. String name, {
  3. String? $fields,
})

Note: This method is deprecated.

Use the signJwt method in the IAM Service Account Credentials API instead. If you currently use this method, see the migration guide for instructions. Signs a JSON Web Token (JWT) using the system-managed private key for a ServiceAccount.

request - The metadata request object.

Request parameters:

name - Required. Deprecated. Migrate to Service Account Credentials API. The resource name of the service account. Use one of the following formats: * projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS} * projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID} As an alternative, you can use the - wildcard character instead of the project ID: * projects/-/serviceAccounts/{EMAIL_ADDRESS} * projects/-/serviceAccounts/{UNIQUE_ID} When possible, avoid using the - wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to access the service account projects/-/serviceAccounts/fake@example.com, which does not exist, the response contains an HTTP 403 Forbidden error instead of a 404 Not Found error. Value must have pattern ^projects/\[^/\]+/serviceAccounts/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a SignJwtResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

@core.Deprecated(
  'Not supported. Member documentation may have more information.',
)
async.Future<SignJwtResponse> signJwt(
  SignJwtRequest request,
  core.String name, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':signJwt';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return SignJwtResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}