Skip to content

Commit

Permalink
Merge pull request #771 from PaloAltoNetworks/frontend/scm-landing-pa…
Browse files Browse the repository at this point in the history
…ge-card

Frontend/scm landing page card
  • Loading branch information
sarette authored Nov 21, 2024
2 parents 4b44537 + 09eb085 commit c67a66e
Show file tree
Hide file tree
Showing 86 changed files with 109,026 additions and 27 deletions.
148 changes: 148 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,36 @@ const config = {
},
],
},
{
label: "Strata Cloud Manager",
to: "#",
colorclass: "scm",
description: "Discover Strata Cloud Manager APIs.",
products: [
{
label: "Strata Cloud Manager",
to: "#",
logoClass: "scm",
docs: [
{
to: "strata-cloud-manager",
label: "Home Page",
icon: "doc",
},
{
to: "scm/docs/home",
label: "Developer's Guide",
icon: "doc",
},
{
to: "scm/docs/release-notes/changelog",
label: "Changelog",
icon: "doc",
},
],
},
],
},
{
label: "Secure Access Service Edge",
to: "#",
Expand Down Expand Up @@ -718,11 +748,119 @@ const config = {
groupPathsBy: "tag",
},
},
scmauth: {
specPath: "openapi-specs/scm/auth",
outputDir: "products/scm/api/auth",
proxy: "https://cors.pan.dev",
sidebarOptions: {
groupPathsBy: "tag",
},
},
iam: {
specPath: "openapi-specs/sase/iam",
outputDir: "products/sase/api/iam",
sidebarOptions: { groupPathsBy: "tag", categoryLinkSource: "info" },
},
scmiam: {
specPath: "openapi-specs/scm/iam",
outputDir: "products/scm/api/iam",
sidebarOptions: { groupPathsBy: "tag", categoryLinkSource: "info" },
},
"config-sase-operations": {
specPath: "openapi-specs/scm/config/sase/operations",
outputDir: "products/scm/api/config/sase/operations",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-sase-setup": {
specPath: "openapi-specs/scm/config/sase/setup",
outputDir: "products/scm/api/config/sase/setup",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-sase-deployment": {
specPath: "openapi-specs/scm/config/sase/deployment",
outputDir: "products/scm/api/config/sase/deployment",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-sase-identity": {
specPath: "openapi-specs/scm/config/sase/identity",
outputDir: "products/scm/api/config/sase/identity",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-sase-mobileagent": {
specPath: "openapi-specs/scm/config/sase/mobileagent",
outputDir: "products/scm/api/config/sase/mobileagent",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-sase-objects": {
specPath: "openapi-specs/scm/config/sase/objects",
outputDir: "products/scm/api/config/sase/objects",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-sase-security": {
specPath: "openapi-specs/scm/config/sase/security",
outputDir: "products/scm/api/config/sase/security",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-ngfw-operations": {
specPath: "openapi-specs/scm/config/ngfw/operations",
outputDir: "products/scm/api/config/ngfw/operations",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-ngfw-setup": {
specPath: "openapi-specs/scm/config/ngfw/setup",
outputDir: "products/scm/api/config/ngfw/setup",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-ngfw-identity": {
specPath: "openapi-specs/scm/config/ngfw/identity",
outputDir: "products/scm/api/config/ngfw/identity",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-ngfw-device": {
specPath: "openapi-specs/scm/config/ngfw/device",
outputDir: "products/scm/api/config/ngfw/device",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-ngfw-network": {
specPath: "openapi-specs/scm/config/ngfw/network",
outputDir: "products/scm/api/config/ngfw/network",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-ngfw-objects": {
specPath: "openapi-specs/scm/config/ngfw/objects",
outputDir: "products/scm/api/config/ngfw/objects",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-ngfw-security": {
specPath: "openapi-specs/scm/config/ngfw/security",
outputDir: "products/scm/api/config/ngfw/security",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-cloudngfw-operations": {
specPath: "openapi-specs/scm/config/cloudngfw/operations",
outputDir: "products/scm/api/config/cloudngfw/operations",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-cloudngfw-setup": {
specPath: "openapi-specs/scm/config/cloudngfw/setup",
outputDir: "products/scm/api/config/cloudngfw/setup",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-cloudngfw-identity": {
specPath: "openapi-specs/scm/config/cloudngfw/identity",
outputDir: "products/scm/api/config/cloudngfw/identity",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-cloudngfw-objects": {
specPath: "openapi-specs/scm/config/cloudngfw/objects",
outputDir: "products/scm/api/config/cloudngfw/objects",
sidebarOptions: { groupPathsBy: "tag" },
},
"config-cloudngfw-security": {
specPath: "openapi-specs/scm/config/cloudngfw/security",
outputDir: "products/scm/api/config/cloudngfw/security",
sidebarOptions: { groupPathsBy: "tag" },
},
adem: {
specPath: "openapi-specs/access/adem",
outputDir: "products/access/api/adem",
Expand Down Expand Up @@ -785,11 +923,21 @@ const config = {
outputDir: "products/sase/api/subscription",
sidebarOptions: { groupPathsBy: "tag" },
},
scmsub: {
specPath: "openapi-specs/scm/subscription",
outputDir: "products/scm/api/subscription",
sidebarOptions: { groupPathsBy: "tag" },
},
tenancy: {
specPath: "openapi-specs/sase/tenancy",
outputDir: "products/sase/api/tenancy",
sidebarOptions: { groupPathsBy: "tag" },
},
scmtenancy: {
specPath: "openapi-specs/scm/tenancy",
outputDir: "products/scm/api/tenancy",
sidebarOptions: { groupPathsBy: "tag" },
},
sdwan: {
specPath: "openapi-specs/sdwan/unified",
outputDir: "products/sdwan/api",
Expand Down
160 changes: 160 additions & 0 deletions openapi-specs/scm/auth/AuthService.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
components:
schemas:
UserInfoResponse:
type: object
properties:
sub:
description: Subject - Identifier for the user at the Issuer
type: string
name:
description: Full name in displayable form including all name parts, possibly
including titles and suffixes
type: string
given_name:
description: Given name(s) or first name(s)
type: string
family_name:
description: Surname(s) or last name(s)
type: string
email:
description: e-mail address
type: string
AccessToken:
type: object
properties:
access_token:
description: The access token issued by the authorization server
type: string
token_type:
description: The type of the token issued (default bearer)
type: string
expires_in:
description: The lifetime in seconds of the access token.
type: integer
scope:
description: The scopes contained in the access token.
type: string
securitySchemes:
Basic:
type: http
scheme: basic
Bearer:
type: http
scheme: bearer
openapi: 3.0.2
paths:
/auth/v1/oauth2/access_token:
post:
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- grant_type
properties:
grant_type:
description: 'Access token grant type. This must always be `client_credentials`.
'
enum:
- client_credentials
type: string
scope:
description: "The scope of the access request. This must be the\
\ \n[TSG ID](/scm/docs/tenant-service-groups) \nfor which you\
\ want to perform API access, and it\nmust be formatted in the\
\ following way: \n\n `\"scope\": \"tsg_id:<TSG_ID>\"`\n\nIf\
\ the service account that you use to authenticate this\nrequest\
\ does not have [role access](/scm/docs/roles) to\nthe TSG specified\
\ in this scope, this API call will\nfail.\n"
type: string
required: true
tags:
- AuthService
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AccessToken'
description: Returns an access token and access token metadata.
'400':
description: Invalid Request
'401':
description: Invalid Client
security:
- Basic: []
summary: Create an access token
description: "Create an access token using a Client ID and Client Secret.\n\n\
Your Client ID is your HTTP basic authentication username, your \nClient Secret\
\ is your HTTP basic authentication password.\n\nYour Client ID and Client\
\ Secrets are created by Strata Cloud Manager when you \n[create a service account](/scm/docs/service-accounts)\n\
or\n[reset your service account](/scm/api/iam/serviceaccounts#operation/resetservice_account).\n\
\nAll access tokens created using this API have a lifetime of 15 minutes.\n"
operationId: post-auth-v1-oauth2-access_token
/auth/v1/oauth2/userinfo:
post:
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- access_token
properties:
access_token:
description: 'Access token for which you want to retrieve claims
about the end-user.
'
type: string
required: true
tags:
- AuthService
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserInfoResponse'
description: Returns oAuth 2.0 claims about the authenticated end-user.
'400':
description: Invalid Request
'401':
description: Invalid Token
summary: Retrieve oAuth oAuth 2.0 claims
description: "Retrieve the oAuth 2.0 claims for the user who was issued \n\
the access token that is presented in this request body.\n"
operationId: post-auth-v1-oauth2-userinfo
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserInfoResponse'
description: Returns claims about the authenticated end-user.
'400':
description: Invalid Request
'401':
description: Invalid Token
security:
- Bearer: []
summary: Retrieve oAuth 2.0 claims
description: "Retrieve the oAuth 2.0 claims for the user who was issued \n\
the access token that is used to authenticate this request.\n"
tags:
- AuthService
operationId: get-auth-v1-oauth2-userinfo
info:
title: Authentication Service API
version: '1.0'
description: 'This service is used to obtain access tokens, and inspect user information
found on the access token.
'
contact: {}
tags:
- name: AuthService
servers:
- url: https://auth.apps.paloaltonetworks.com
Loading

0 comments on commit c67a66e

Please sign in to comment.