gocloak

https://pkg.go.dev/github.com/Nerzal/gocloak/v14
Admin
gocloak is a Golang Keycloak client that provides an API adapter for authentication, user...
Tokens:864
Snippets:16
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### func SignClaims(claims jwt.Claims, key any, method jwt.SigningMethod) (string, error)

Source: https://pkg.go.dev/github.com/Nerzal/gocloak/v14/pkg/jwx

Signs the given claims using a given key and a signing method.

```APIDOC
## func SignClaims

### Description
SignClaims signs the given claims using a given key and a method.

### Signature
```go
func SignClaims(claims jwt.Claims, key any, method jwt.SigningMethod) (string, error)
```

### Parameters
- **claims** (jwt.Claims) - Required - The claims to sign.
- **key** (any) - Required - The key used for signing.
- **method** (jwt.SigningMethod) - Required - The signing method to use.

### Returns
- **(string, error)** - The signed token string and an error if any.
```

--------------------------------

### func DecodeAccessTokenRSACustomClaims(accessToken string, e, n *string, customClaims jwt.Claims) (*jwt.Token, error)

Source: https://pkg.go.dev/github.com/Nerzal/gocloak/v14/pkg/jwx

Decodes a string access token into a jwt.Token using RSA custom claims.

```APIDOC
## func DecodeAccessTokenRSACustomClaims

### Description
DecodeAccessTokenRSACustomClaims decodes string access token into jwt.Token.

### Signature
```go
func DecodeAccessTokenRSACustomClaims(accessToken string, e, n *string, customClaims jwt.Claims) (*jwt.Token, error)
```

### Parameters
- **accessToken** (string) - Required - The access token string to decode.
- **e** (*string) - Required - The exponent of the RSA public key.
- **n** (*string) - Required - The modulus of the RSA public key.
- **customClaims** (jwt.Claims) - Required - Custom claims to be populated.

### Returns
- **(*jwt.Token, error)** - The decoded JWT token and an error if any.
```

--------------------------------

### func DecodeAccessTokenHeader(token string) (*DecodedAccessTokenHeader, error)

Source: https://pkg.go.dev/github.com/Nerzal/gocloak/v14/pkg/jwx

Decodes the header of an access token.

```APIDOC
## func DecodeAccessTokenHeader

### Description
DecodeAccessTokenHeader decodes the header of the accessToken.

### Signature
```go
func DecodeAccessTokenHeader(token string) (*DecodedAccessTokenHeader, error)
```

### Parameters
- **token** (string) - Required - The access token string.

### Returns
- **(*DecodedAccessTokenHeader, error)** - The decoded header and an error if any.
```

--------------------------------

### func DecodeAccessTokenECDSACustomClaims(accessToken string, x, y, crv *string, customClaims jwt.Claims) (*jwt.Token, error)

Source: https://pkg.go.dev/github.com/Nerzal/gocloak/v14/pkg/jwx

Decodes a string access token into a jwt.Token using ECDSA custom claims.

```APIDOC
## func DecodeAccessTokenECDSACustomClaims

### Description
DecodeAccessTokenECDSACustomClaims decodes string access token into jwt.Token.

### Signature
```go
func DecodeAccessTokenECDSACustomClaims(accessToken string, x, y, crv *string, customClaims jwt.Claims) (*jwt.Token, error)
```

### Parameters
- **accessToken** (string) - Required - The access token string to decode.
- **x** (*string) - Required - The X coordinate of the ECDSA public key.
- **y** (*string) - Required - The Y coordinate of the ECDSA public key.
- **crv** (*string) - Required - The curve name of the ECDSA public key.
- **customClaims** (jwt.Claims) - Required - Custom claims to be populated.

### Returns
- **(*jwt.Token, error)** - The decoded JWT token and an error if any.
```
Tokens:
Raw