iya-sts
    Preparing search index...

    Variable describe

    describe: (key: any, options?: DescribeOptions) => KeyResult = ...

    Type Declaration

      • (key: any, options?: DescribeOptions): KeyResult
      • Turns a key by value or by reference into a descriptor.

        A reference is resolved through options.resolveReference(), which answers null for an unknown one; the caller turns that into invalid_client.

        Parameters

        • key: any

          the key, an object or a reference string

        • Optionaloptions: DescribeOptions

          resolveReference(reference), how a reference becomes key material

        Returns KeyResult

        { ok: true, ... } carrying the descriptor, or a refusal