Class KeycloakProtectionClient

Namespace

Keycloak.AuthServices.Sdk.Protection

Assembly

Keycloak.AuthServices.Sdk.dll

Represents a client for interacting with Keycloak Protection API services.

public class KeycloakProtectionClient : IKeycloakProtectionClient, IKeycloakProtectedResourceClient, IKeycloakPolicyClient, IKeycloakPermissionClient

Inheritance

object

KeycloakProtectionClient

Implements

IKeycloakProtectionClient

IKeycloakProtectedResourceClient

IKeycloakPolicyClient

IKeycloakPermissionClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Initializes a new instance of the KeycloakProtectionClient class.

Constructors

KeycloakProtectionClient(HttpClient)

Represents a client for interacting with Keycloak Protection API services.

public KeycloakProtectionClient(HttpClient httpClient)

Parameters

httpClient HttpClient

The HTTP client used for making requests.

Remarks

Initializes a new instance of the KeycloakProtectionClient class.

Methods

CreatePermissionTicketWithResponseAsync(string, IList<PermissionTicketRequest>, CancellationToken)

Creates a permission ticket for the specified resources and scopes.

public 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.

CreatePolicyWithResponseAsync(string, string, Policy, CancellationToken)

Creates a policy

public Task<HttpResponseMessage> CreatePolicyWithResponseAsync(string realm, string resourceId, Policy policy, CancellationToken cancellationToken)

Parameters

realm string

Realm name (not ID).

resourceId string

The resource ID to create the policy for.

policy Policy

Policy representation

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

The HttpResponseMessage of the request

CreateResourceWithResponseAsync(string, Resource, CancellationToken)

Creates resource

public Task<HttpResponseMessage> CreateResourceWithResponseAsync(string realm, Resource resource, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

resource Resource

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

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.

public 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.

DeletePermissionTicketWithResponseAsync(string, string, CancellationToken)

Deletes a permission ticket.

public 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.

DeletePolicyWithResponseAsync(string, string, CancellationToken)

Deletes a policy

public Task<HttpResponseMessage> DeletePolicyWithResponseAsync(string realm, string policyId, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

policyId string

Policy ID.

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

Remarks

https://github.com/keycloak/keycloak/blob/main/docs/documentation/authorization_services/topics/service-protection-policy-api.adoc#removing-a-permission

DeleteResourceWithResponseAsync(string, string, CancellationToken)

Deletes a resource

public Task<HttpResponseMessage> DeleteResourceWithResponseAsync(string realm, string resourceId, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

resourceId string

Resource ID.

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

GetPermissionTicketsWithResponseAsync(string, GetPermissionTicketsRequestParameters?, CancellationToken)

Gets permission tickets with optional filtering.

public 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.

GetPoliciesWithResponseAsync(string, GetPoliciesRequestParameters?, CancellationToken)

Gets all Policies

public Task<HttpResponseMessage> GetPoliciesWithResponseAsync(string realm, GetPoliciesRequestParameters? parameters = null, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

parameters GetPoliciesRequestParameters

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

The HttpResponseMessage of the request

Remarks

https://github.com/keycloak/keycloak/blob/main/docs/documentation/authorization_services/topics/service-protection-policy-api.adoc#querying-permission

GetPolicyWithResponseAsync(string, string, CancellationToken)

Gets a Policy

public Task<HttpResponseMessage> GetPolicyWithResponseAsync(string realm, string policyId, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

policyId string

Policy ID

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

The HttpResponseMessage of the request

GetResourceWithResponseAsync(string, string, CancellationToken)

Gets resource by Id

public Task<HttpResponseMessage> GetResourceWithResponseAsync(string realm, string resourceId, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

resourceId string

Resource ID.

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

GetResourcesIdsWithResponseAsync(string, GetResourcesRequestParameters?, CancellationToken)

Searches for resource

public Task<HttpResponseMessage> GetResourcesIdsWithResponseAsync(string realm, GetResourcesRequestParameters? parameters = null, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

parameters GetResourcesRequestParameters

Optional query parameters

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

GetResourcesWithResponseAsync(string, GetResourcesRequestParameters?, CancellationToken)

Searches for resources

public Task<HttpResponseMessage> GetResourcesWithResponseAsync(string realm, GetResourcesRequestParameters? parameters = null, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

parameters GetResourcesRequestParameters

Optional query parameters

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

UpdatePermissionTicketWithResponseAsync(string, PermissionTicket, CancellationToken)

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

public 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.

UpdatePolicyWithResponseAsync(string, string, Policy, CancellationToken)

Updates a policy

public Task<HttpResponseMessage> UpdatePolicyWithResponseAsync(string realm, string policyId, Policy policy, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

policyId string

Policy ID.

policy Policy

Policy object.

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

Remarks

https://github.com/keycloak/keycloak/blob/main/docs/documentation/authorization_services/topics/service-protection-policy-api.adoc#managing-resource-permissions-using-the-policy-api

UpdateResourceWithResponseAsync(string, string, Resource, CancellationToken)

Updates resource

public Task<HttpResponseMessage> UpdateResourceWithResponseAsync(string realm, string resourceId, Resource resource, CancellationToken cancellationToken = default)

Parameters

realm string

Realm name (not ID).

resourceId string

Resource ID.

resource Resource

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

Remarks

Docs: https://github.com/keycloak/keycloak-documentation/blob/main/authorization_services/topics/service-protection-resources-api-papi.adoc#updating-resources