Table of Contents

Interface IKeycloakPermissionClient

Namespace
Keycloak.AuthServices.Sdk.Protection
Assembly
Keycloak.AuthServices.Sdk.dll

UMA Permission API — creates permission tickets and queries existing ones.

public interface IKeycloakPermissionClient

Remarks

See: https://www.keycloak.org/docs/latest/authorization_services/index.html#_service_protection_permission_api_papi

Methods

CreatePermissionTicketAsync(string, IList<PermissionTicketRequest>, CancellationToken)

Creates a permission ticket for the specified resources and scopes.

Task<PermissionTicketResponse> CreatePermissionTicketAsync(string realm, IList<PermissionTicketRequest> permissions, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

permissions IList<PermissionTicketRequest>

The permission requests.

cancellationToken CancellationToken

Returns

Task<PermissionTicketResponse>

The permission ticket response containing the ticket string.

CreatePermissionTicketWithResponseAsync(string, IList<PermissionTicketRequest>, CancellationToken)

Creates a permission ticket for the specified resources and scopes.

Task<HttpResponseMessage> CreatePermissionTicketWithResponseAsync(string realm, IList<PermissionTicketRequest> permissions, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

permissions IList<PermissionTicketRequest>

The permission requests.

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

The HttpResponseMessage of the request.

CreateStoredPermissionTicketAsync(string, PermissionTicket, CancellationToken)

Creates a stored permission ticket (e.g., to request access to a resource). This uses the /permission/ticket endpoint, not the UMA permission endpoint.

Task<PermissionTicket> CreateStoredPermissionTicketAsync(string realm, PermissionTicket ticket, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

ticket PermissionTicket

The permission ticket to create.

cancellationToken CancellationToken

Returns

Task<PermissionTicket>

The created permission ticket.

CreateStoredPermissionTicketWithResponseAsync(string, PermissionTicket, CancellationToken)

Creates a stored permission ticket (e.g., to request access to a resource). This uses the /permission/ticket endpoint, not the UMA permission endpoint.

Task<HttpResponseMessage> CreateStoredPermissionTicketWithResponseAsync(string realm, PermissionTicket ticket, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

ticket PermissionTicket

The permission ticket to create.

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

The HttpResponseMessage of the request.

DeletePermissionTicketAsync(string, string, CancellationToken)

Deletes a permission ticket.

Task DeletePermissionTicketAsync(string realm, string ticketId, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

ticketId string

The permission ticket ID.

cancellationToken CancellationToken

Returns

Task

DeletePermissionTicketWithResponseAsync(string, string, CancellationToken)

Deletes a permission ticket.

Task<HttpResponseMessage> DeletePermissionTicketWithResponseAsync(string realm, string ticketId, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

ticketId string

The permission ticket ID.

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

The HttpResponseMessage of the request.

GetPermissionTicketsAsync(string, GetPermissionTicketsRequestParameters?, CancellationToken)

Gets permission tickets with optional filtering.

Task<IList<PermissionTicket>> GetPermissionTicketsAsync(string realm, GetPermissionTicketsRequestParameters? parameters = null, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

parameters GetPermissionTicketsRequestParameters

Optional query parameters for filtering.

cancellationToken CancellationToken

Returns

Task<IList<PermissionTicket>>

A list of permission tickets.

GetPermissionTicketsWithResponseAsync(string, GetPermissionTicketsRequestParameters?, CancellationToken)

Gets permission tickets with optional filtering.

Task<HttpResponseMessage> GetPermissionTicketsWithResponseAsync(string realm, GetPermissionTicketsRequestParameters? parameters = null, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

parameters GetPermissionTicketsRequestParameters

Optional query parameters for filtering.

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

The HttpResponseMessage of the request.

UpdatePermissionTicketAsync(string, PermissionTicket, CancellationToken)

Updates a permission ticket (e.g., to approve or revoke).

Task UpdatePermissionTicketAsync(string realm, PermissionTicket ticket, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

ticket PermissionTicket

The permission ticket with updated fields.

cancellationToken CancellationToken

Returns

Task

UpdatePermissionTicketWithResponseAsync(string, PermissionTicket, CancellationToken)

Updates a permission ticket (e.g., to approve or revoke).

Task<HttpResponseMessage> UpdatePermissionTicketWithResponseAsync(string realm, PermissionTicket ticket, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

ticket PermissionTicket

The permission ticket with updated fields.

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

The HttpResponseMessage of the request.