AuthorizationService (Oracle Fusion Middleware Java API Reference for Oracle Access Management Mobile and Social)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Fusion Middleware Java API Reference for Oracle Access Management Mobile and Social

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.security.idaas.rest.provider.authorization
Interface AuthorizationService

public interface AuthorizationService

The AuthorizationService interface will verify user authorization against created policies. Currently, the interface can check whether the user is authorized to perform a particular operation (GET or POST) on a particular HTTP resource. The resource policy needs to be populated with the following information. - subjectid defines Unique opaque value can identify the client to test the resource privilege. - action defines the operation for which authorization is being requested. - resource defines the resource for which authorization is being requested.

Method Summary
`java.util.Map<java.lang.String,java.lang.String>`	`authorize(SecurityContext securityCtx, SubjectID subjectid, oracle.security.idaas.rest.common.Action action, oracle.security.idaas.rest.common.Resource resource, java.util.Map queryParams)` Authorize the end user's privilege on the resource for specified action.

Method Detail

authorize

java.util.Map<java.lang.String,java.lang.String> authorize(SecurityContext securityCtx,
                                                           SubjectID subjectid,
                                                           oracle.security.idaas.rest.common.Action action,
                                                           oracle.security.idaas.rest.common.Resource resource,
                                                           java.util.Map queryParams)
                                                           throws RESTNotFoundException,
                                                                  RESTForbiddenException,
                                                                  RESTUnauthorizedException,
                                                                  RESTBadRequestException

Authorize the end user's privilege on the resource for specified action.

Parameters:: securityCtx - defines the caller identity who submit this request together with filtersubject value that can authorize and validate this request.; subjectid - Unique opaque value can identify the client to test the resource privilege.; action - Target action name to test the resource privilege. If not specified, it is assumed to be GET.; resource - Target resource to test the privilege.; queryParams - which contains the provider specific query params.
Returns:: AuthZ result. Returns may include ADVICE information
Throws:: RESTMethodNotAllowedException - if rest operation is not allowed.; RESTMethodNotAllowedException -
- if rest operation is not allowed.; RESTBadRequestException -
- if the request has mismatched parameters.; OICRTException - - if there is any error for processing authorization.; RESTNotFoundException; RESTForbiddenException; RESTUnauthorizedException; RESTBadRequestException