All REST Endpoints

Sort by

Task Path Method

Group by API

Admin/Application

An Application is the Resource Server that hosts the protected resources. The REST endpoint is used to Create, Read, Update and Delete an Application.

Add a new Resource Server

Method: post

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/application

Delete a Resource Server by name or ID

Method: delete

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/application

Find OAuth Resource Server by name or ID

Method: get

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/application

Update an existing OAuth Resource Server either based on the name of the resource server or the ID of the resource server.

Method: put

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/application

Admin/Client

A Client is an application making protected resource requests on behalf of the resource owner and with the resource owner's authorization. The REST endpoint is used to Create, Read, Update and Delete a Client.

Add a new OAuth Client

Method: post

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/client

Delete a Client by name or Client Id

Method: delete

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/client

Find OAuth Client by name or ID

Method: get

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/client

Update an existing OAuth Client based on the name of the client.

Method: put

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/client

Admin/Client Artifact

The REST endpoint is used to import and delete a Client Certificate.

Add a client certificate under a Client

Method: post

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/clientartifacts

Delete the certificate under a Client

Method: delete

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/clientartifacts

Admin/Identity Domain

An Identity Domain corresponds to the notion of a tenant. All clients and resource servers are created under an Identity Domain. The REST endpoint is used to Create, Read, Update and Delete and Identity Domain.

Add a new OAuth Identity Domain

Method: post

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/oauthidentitydomain

Delete an Identity Domain by name or ID

Method: delete

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/oauthidentitydomain

Find OAuth Identity Domain by name or ID

Method: get

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/oauthidentitydomain

Update an existing OAuth Identity Domain

Method: put

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/oauthidentitydomain

Admin/Trust Artifact

The REST endpoint is used to import and delete a certificate from the trust store under an Identity Domain.

Add a new trust artifact under an Identity Domain

Method: post

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/trustartifacts

Delete a Trust Artifact under an IdentityDomain based on the Artifact Identifier

Method: delete

Path: /oam/services/rest/ssa/api/v1/oauthpolicyadmin/trustartifacts

Runtime/Create Token

The REST end point is used to create an Access Token.The same end point is used for ClientCredentials Flow, Resource Owner Password Credential Flow, JWT Bearer Flow and Authorization Code Flow.

Create Access Token Flow

Method: post

Path: /oauth2/rest/token

Runtime/Validate Token

The REST end point is used to validate an Access Token.

Validate Access Token Flow

Method: get

Path: /oauth2/rest/token/info