# api_key.convert_raw_key

Convert a raw API key into its SCRAM authentication components.

This allows API key consumers to transform a raw API key (format: id-key) into the precomputed SCRAM authentication material for improved performance.

NOTE: this is a convenience function for API consumers. It does not impact API key stored server-side.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: raw_key

#### raw_key

Type: string

The raw API key to convert (format: id-key).

Must be at least `1` characters long

##

#### ApiKeyScramData

Type: object

SCRAM authentication data derived from the raw API key.

No Additional Properties

##

#### Api Key Id

Type: integer

API key ID.

##

#### Iterations

Type: integer

Number of iterations of PBKDF2-SHA512.

##

#### Salt

Type: string

Base64 encoded salt for API key.

##

#### Client Key

Type: string

Pre-computed SCRAM ClientKey.

##

#### Stored Key

Type: string

SCRAM StoredKey for API key.

##

#### Server Key

Type: string

SCRAM ServerKey for API key.

Required roles: API_KEY_READ