createActorToken method

Future<ActorToken?> createActorToken({
  1. CreateActorTokenRequest? createActorTokenRequest,
})

Create actor token

Create an actor token that can be used to impersonate the given user. The actor parameter needs to include at least a "sub" key whose value is the ID of the actor (impersonating) user.

Parameters:

Implementation

Future<ActorToken?> createActorToken({
  CreateActorTokenRequest? createActorTokenRequest,
}) async {
  final response = await createActorTokenWithHttpInfo(
    createActorTokenRequest: createActorTokenRequest,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty &&
      response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'ActorToken',
    ) as ActorToken;
  }
  return null;
}