doc.go

/*
 * Copyright © 2015-2018 Aeneas Rekkas <aeneas+oss@aeneas.io>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * @author		Aeneas Rekkas <aeneas+oss@aeneas.io>
 * @copyright 	2015-2018 Aeneas Rekkas <aeneas+oss@aeneas.io>
 * @license 	Apache-2.0
 */

// Package warden implements endpoints capable of making access control decisions based on Access Control Policies

package warden

import (
	"github.com/ory/hydra/firewall"
)

// The warden access request response
// swagger:model wardenAccessRequestResponse
type swaggerWardenAccessRequestResponse struct {
	// Allowed is true if the request is allowed and false otherwise.
	Allowed bool `json:"allowed"`
}

// swagger:parameters doesWardenAllowAccessRequest
type swaggerDoesWardenAllowAccessRequestParameters struct {
	// in: body
	Body firewall.AccessRequest
}

// swagger:parameters doesWardenAllowTokenAccessRequest
type swaggerDoesWardenAllowTokenAccessRequestParameters struct {
	// in: body
	Body swaggerWardenTokenAccessRequest
}

// swagger:model wardenTokenAccessRequest
type swaggerWardenTokenAccessRequest struct {
	// Scopes is an array of scopes that are requried.
	Scopes []string `json:"scopes"`

	// Token is the token to introspect.
	Token string `json:"token"`

	// Resource is the resource that access is requested to.
	Resource string `json:"resource"`

	// Action is the action that is requested on the resource.
	Action string `json:"action"`

	// Context is the request's environmental context.
	Context map[string]interface{} `json:"context"`
}

// The warden access request (with token) response
// swagger:model wardenTokenAccessRequestResponse
type swaggerWardenTokenAccessRequestResponsePayload struct {
	// Subject is the identity that authorized issuing the token, for example a user or an OAuth2 app.
	// This is usually a uuid but you can choose a urn or some other id too.
	Subject string `json:"subject"`

	// GrantedScopes is a list of scopes that the subject authorized when asked for consent.
	GrantedScopes []string `json:"grantedScopes"`

	// Issuer is the id of the issuer, typically an hydra instance.
	Issuer string `json:"issuer"`

	// ClientID is the id of the OAuth2 client that requested the token.
	ClientID string `json:"clientId"`

	// IssuedAt is the token creation time stamp.
	IssuedAt string `json:"issuedAt"`

	// ExpiresAt is the expiry timestamp.
	ExpiresAt string `json:"expiresAt"`

	// Extra represents arbitrary session data.
	Extra map[string]interface{} `json:"accessTokenExtra"`

	// Allowed is true if the request is allowed and false otherwise.
	Allowed bool `json:"allowed"`
}