Skip to content

Latest commit

 

History

History
98 lines (55 loc) · 4.09 KB

WardenApi.md

File metadata and controls

98 lines (55 loc) · 4.09 KB

\WardenApi

All URIs are relative to http://localhost

Method HTTP request Description
IsOAuth2AccessTokenAuthorized Post /warden/oauth2/access-tokens/authorize Check if an OAuth 2.0 access token is authorized to access a resource
IsOAuth2ClientAuthorized Post /warden/oauth2/clients/authorize Check if an OAuth 2.0 Client is authorized to access a resource
IsSubjectAuthorized Post /warden/subjects/authorize Check if a subject is authorized to access a resource

IsOAuth2AccessTokenAuthorized

WardenOAuth2AccessTokenAuthorizationResponse IsOAuth2AccessTokenAuthorized($body)

Check if an OAuth 2.0 access token is authorized to access a resource

Checks if a token is valid and if the token subject is allowed to perform an action on a resource. This endpoint requires a token, a scope, a resource name, an action name and a context. If a token is expired/invalid, has not been granted the requested scope or the subject is not allowed to perform the action on the resource, this endpoint returns a 200 response with { \"allowed\": false }. This endpoint passes all data from the upstream OAuth 2.0 token introspection endpoint. If you use ORY Hydra as an upstream OAuth 2.0 provider, data set through the accessTokenExtra field in the consent flow will be included in this response as well.

Parameters

Name Type Description Notes
body WardenOAuth2AccessTokenAuthorizationRequest [optional]

Return type

WardenOAuth2AccessTokenAuthorizationResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

IsOAuth2ClientAuthorized

WardenOAuth2ClientAuthorizationResponse IsOAuth2ClientAuthorized($body)

Check if an OAuth 2.0 Client is authorized to access a resource

Checks if an OAuth 2.0 Client provided the correct access credentials and and if the client is allowed to perform an action on a resource. This endpoint requires a client id, a client secret, a scope, a resource name, an action name and a context.

Parameters

Name Type Description Notes
body WardenOAuth2ClientAuthorizationRequest [optional]

Return type

WardenOAuth2ClientAuthorizationResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

IsSubjectAuthorized

WardenSubjectAuthorizationResponse IsSubjectAuthorized($body)

Check if a subject is authorized to access a resource

Checks if a subject (e.g. user ID, API key, ...) is allowed to perform a certain action on a resource.

Parameters

Name Type Description Notes
body WardenSubjectAuthorizationRequest [optional]

Return type

WardenSubjectAuthorizationResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]