Function signRequest

signRequest(
    rawSecret: string,
    rawCanonicalRequest: {
        method:
            | "GET"
            | "POST"
            | "PUT"
            | "PATCH"
            | "HEAD"
            | "DELETE"
            | "OPTIONS";
        path: string;
    } & { body?: string; headers?: { [_: string]: string } },
    rawTimestamp?: number,
): SignedRequestWithoutContextHeaders
Given a secret, a canonical request, a timestamp and context headers, generates a signature.
Parameters
- rawSecret: string
- rawCanonicalRequest: {
  method: "GET" | "POST" | "PUT" | "PATCH" | "HEAD" | "DELETE" | "OPTIONS";
  path: string;
  } & { body?: string; headers?: { [_: string]: string } }
- OptionalrawTimestamp: number
Returns SignedRequestWithoutContextHeaders
- Defined in requests/sign-request.ts:71
signRequest(
    rawSecret: string,
    rawCanonicalRequest: {
        method:
            | "GET"
            | "POST"
            | "PUT"
            | "PATCH"
            | "HEAD"
            | "DELETE"
            | "OPTIONS";
        path: string;
    } & { body?: string; headers?: { [_: string]: string } },
    rawTimestamp?: number,
    rawContext?: Context<SubjectHeadersApp>,
): SignedRequestWithContextHeadersWithApp
Given a secret, a canonical request, a timestamp and context headers, generates a signature.
Parameters
- rawSecret: string
- rawCanonicalRequest: {
  method: "GET" | "POST" | "PUT" | "PATCH" | "HEAD" | "DELETE" | "OPTIONS";
  path: string;
  } & { body?: string; headers?: { [_: string]: string } }
- OptionalrawTimestamp: number
- OptionalrawContext: Context<SubjectHeadersApp>
Returns SignedRequestWithContextHeadersWithApp
- Defined in requests/sign-request.ts:76
signRequest(
    rawSecret: string,
    rawCanonicalRequest: {
        method:
            | "GET"
            | "POST"
            | "PUT"
            | "PATCH"
            | "HEAD"
            | "DELETE"
            | "OPTIONS";
        path: string;
    } & { body?: string; headers?: { [_: string]: string } },
    rawTimestamp?: number,
    rawContext?: Context<SubjectHeadersUser>,
): SignedRequestWithContextHeadersWithUser
Given a secret, a canonical request, a timestamp and context headers, generates a signature.
Parameters
- rawSecret: string
- rawCanonicalRequest: {
  method: "GET" | "POST" | "PUT" | "PATCH" | "HEAD" | "DELETE" | "OPTIONS";
  path: string;
  } & { body?: string; headers?: { [_: string]: string } }
- OptionalrawTimestamp: number
- OptionalrawContext: Context<SubjectHeadersUser>
Returns SignedRequestWithContextHeadersWithUser
- Defined in requests/sign-request.ts:82

Function signRequest

Parameters

Returns SignedRequestWithoutContextHeaders

Parameters

Returns SignedRequestWithContextHeadersWithApp

Parameters

Returns SignedRequestWithContextHeadersWithUser

Settings