mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-10 04:19:19 +00:00
Apply automatic changes
This commit is contained in:
tyler-mairose-sp
committed by
github-actions[bot]
github-actions[bot]
parent
605e0845ce
commit
b7fc9272f8
@@ -32525,10 +32525,12 @@ paths:
|
||||
example: 2c9180835d2e5168015d32f890ca1581
|
||||
businessName:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The name of the business the API Client should belong to
|
||||
example: Acme-Solar
|
||||
homepageUrl:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The homepage URL associated with the owner of the API Client
|
||||
example: 'http://localhost:12345'
|
||||
name:
|
||||
@@ -32537,18 +32539,22 @@ paths:
|
||||
example: Demo API Client
|
||||
description:
|
||||
type: string
|
||||
nullable: true
|
||||
description: A description of the API Client
|
||||
example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows'
|
||||
accessTokenValiditySeconds:
|
||||
type: string
|
||||
type: integer
|
||||
format: int32
|
||||
description: The number of seconds an access token generated for this API Client is valid for
|
||||
example: 750
|
||||
refreshTokenValiditySeconds:
|
||||
type: string
|
||||
type: integer
|
||||
format: int32
|
||||
description: The number of seconds a refresh token generated for this API Client is valid for
|
||||
example: 86400
|
||||
redirectUris:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
description: A list of the approved redirect URIs used with the authorization_code flow
|
||||
@@ -32609,6 +32615,16 @@ paths:
|
||||
format: date-time
|
||||
description: 'The date and time, down to the millisecond, when the API Client was last updated'
|
||||
example: '2018-06-25T20:22:28.104Z'
|
||||
scope:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
default: 'sp:scopes:all'
|
||||
description: Scopes of the API Client.
|
||||
example:
|
||||
- 'demo:api-client-scope:first'
|
||||
- 'demo:api-client-scope:second'
|
||||
required:
|
||||
- id
|
||||
- businessName
|
||||
@@ -32627,6 +32643,7 @@ paths:
|
||||
- claimsSupported
|
||||
- created
|
||||
- modified
|
||||
- scope
|
||||
'400':
|
||||
description: Client Error - Returned if the request body is invalid.
|
||||
content:
|
||||
@@ -32856,18 +32873,22 @@ paths:
|
||||
properties:
|
||||
businessName:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The name of the business the API Client should belong to
|
||||
example: Acme-Solar
|
||||
homepageUrl:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The homepage URL associated with the owner of the API Client
|
||||
example: 'http://localhost:12345'
|
||||
name:
|
||||
type: string
|
||||
nullable: true
|
||||
description: A human-readable name for the API Client
|
||||
example: Demo API Client
|
||||
description:
|
||||
type: string
|
||||
nullable: true
|
||||
description: A description of the API Client
|
||||
example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows'
|
||||
accessTokenValiditySeconds:
|
||||
@@ -32882,6 +32903,7 @@ paths:
|
||||
format: int32
|
||||
redirectUris:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
description: A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client.
|
||||
@@ -32889,6 +32911,7 @@ paths:
|
||||
- 'http://localhost:12345'
|
||||
grantTypes:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
description: OAuth2 Grant Type
|
||||
type: string
|
||||
@@ -32932,6 +32955,16 @@ paths:
|
||||
type: boolean
|
||||
description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow
|
||||
example: false
|
||||
scope:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
default: 'sp:scopes:all'
|
||||
description: 'Scopes of the API Client. If no scope is specified, the client will be created with the default scope "sp:scopes:all". This means the API Client will have all the rights of the owner who created it.'
|
||||
example:
|
||||
- 'demo:api-client-scope:first'
|
||||
- 'demo:api-client-scope:second'
|
||||
required:
|
||||
- name
|
||||
- description
|
||||
@@ -33043,6 +33076,16 @@ paths:
|
||||
format: date-time
|
||||
description: 'The date and time, down to the millisecond, when the API Client was last updated'
|
||||
example: '2018-06-25T20:22:28.104Z'
|
||||
scope:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
default: 'sp:scopes:all'
|
||||
description: Scopes of the API Client.
|
||||
example:
|
||||
- 'demo:api-client-scope:first'
|
||||
- 'demo:api-client-scope:second'
|
||||
required:
|
||||
- id
|
||||
- secret
|
||||
@@ -33062,6 +33105,7 @@ paths:
|
||||
- claimsSupported
|
||||
- created
|
||||
- modified
|
||||
- scope
|
||||
'400':
|
||||
description: Client Error - Returned if the request body is invalid.
|
||||
content:
|
||||
@@ -33305,10 +33349,12 @@ paths:
|
||||
example: 2c9180835d2e5168015d32f890ca1581
|
||||
businessName:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The name of the business the API Client should belong to
|
||||
example: Acme-Solar
|
||||
homepageUrl:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The homepage URL associated with the owner of the API Client
|
||||
example: 'http://localhost:12345'
|
||||
name:
|
||||
@@ -33317,18 +33363,22 @@ paths:
|
||||
example: Demo API Client
|
||||
description:
|
||||
type: string
|
||||
nullable: true
|
||||
description: A description of the API Client
|
||||
example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows'
|
||||
accessTokenValiditySeconds:
|
||||
type: string
|
||||
type: integer
|
||||
format: int32
|
||||
description: The number of seconds an access token generated for this API Client is valid for
|
||||
example: 750
|
||||
refreshTokenValiditySeconds:
|
||||
type: string
|
||||
type: integer
|
||||
format: int32
|
||||
description: The number of seconds a refresh token generated for this API Client is valid for
|
||||
example: 86400
|
||||
redirectUris:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
description: A list of the approved redirect URIs used with the authorization_code flow
|
||||
@@ -33389,6 +33439,16 @@ paths:
|
||||
format: date-time
|
||||
description: 'The date and time, down to the millisecond, when the API Client was last updated'
|
||||
example: '2018-06-25T20:22:28.104Z'
|
||||
scope:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
default: 'sp:scopes:all'
|
||||
description: Scopes of the API Client.
|
||||
example:
|
||||
- 'demo:api-client-scope:first'
|
||||
- 'demo:api-client-scope:second'
|
||||
required:
|
||||
- id
|
||||
- businessName
|
||||
@@ -33407,6 +33467,7 @@ paths:
|
||||
- claimsSupported
|
||||
- created
|
||||
- modified
|
||||
- scope
|
||||
'400':
|
||||
description: Client Error - Returned if the request body is invalid.
|
||||
content:
|
||||
@@ -34079,10 +34140,12 @@ paths:
|
||||
example: 2c9180835d2e5168015d32f890ca1581
|
||||
businessName:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The name of the business the API Client should belong to
|
||||
example: Acme-Solar
|
||||
homepageUrl:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The homepage URL associated with the owner of the API Client
|
||||
example: 'http://localhost:12345'
|
||||
name:
|
||||
@@ -34091,18 +34154,22 @@ paths:
|
||||
example: Demo API Client
|
||||
description:
|
||||
type: string
|
||||
nullable: true
|
||||
description: A description of the API Client
|
||||
example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows'
|
||||
accessTokenValiditySeconds:
|
||||
type: string
|
||||
type: integer
|
||||
format: int32
|
||||
description: The number of seconds an access token generated for this API Client is valid for
|
||||
example: 750
|
||||
refreshTokenValiditySeconds:
|
||||
type: string
|
||||
type: integer
|
||||
format: int32
|
||||
description: The number of seconds a refresh token generated for this API Client is valid for
|
||||
example: 86400
|
||||
redirectUris:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
description: A list of the approved redirect URIs used with the authorization_code flow
|
||||
@@ -34163,6 +34230,16 @@ paths:
|
||||
format: date-time
|
||||
description: 'The date and time, down to the millisecond, when the API Client was last updated'
|
||||
example: '2018-06-25T20:22:28.104Z'
|
||||
scope:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
default: 'sp:scopes:all'
|
||||
description: Scopes of the API Client.
|
||||
example:
|
||||
- 'demo:api-client-scope:first'
|
||||
- 'demo:api-client-scope:second'
|
||||
required:
|
||||
- id
|
||||
- businessName
|
||||
@@ -34181,6 +34258,7 @@ paths:
|
||||
- claimsSupported
|
||||
- created
|
||||
- modified
|
||||
- scope
|
||||
'400':
|
||||
description: Client Error - Returned if the request body is invalid.
|
||||
content:
|
||||
@@ -34498,6 +34576,16 @@ paths:
|
||||
type: string
|
||||
description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.
|
||||
example: NodeJS Integration
|
||||
scope:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
default: 'sp:scopes:all'
|
||||
description: Scopes of the personal access token.
|
||||
example:
|
||||
- 'demo:personal-access-token-scope:first'
|
||||
- 'demo:personal-access-token-scope:second'
|
||||
owner:
|
||||
description: Details about the owner of the personal access token.
|
||||
type: object
|
||||
@@ -34549,6 +34637,7 @@ paths:
|
||||
required:
|
||||
- id
|
||||
- name
|
||||
- scope
|
||||
- owner
|
||||
- created
|
||||
'400':
|
||||
@@ -34786,6 +34875,16 @@ paths:
|
||||
type: string
|
||||
description: The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created.
|
||||
example: NodeJS Integration
|
||||
scope:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
default: 'sp:scopes:all'
|
||||
description: 'Scopes of the personal access token. If no scope is specified, the token will be created with the default scope "sp:scopes:all". This means the personal access token will have all the rights of the owner who created it.'
|
||||
example:
|
||||
- 'demo:personal-access-token-scope:first'
|
||||
- 'demo:personal-access-token-scope:second'
|
||||
required:
|
||||
- name
|
||||
responses:
|
||||
@@ -34804,6 +34903,16 @@ paths:
|
||||
type: string
|
||||
description: The secret of the personal access token (to be used as the password for Basic Auth).
|
||||
example: 1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9
|
||||
scope:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
default: 'sp:scopes:all'
|
||||
description: Scopes of the personal access token.
|
||||
example:
|
||||
- 'demo:personal-access-token-scope:first'
|
||||
- 'demo:personal-access-token-scope:second'
|
||||
name:
|
||||
type: string
|
||||
description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.
|
||||
@@ -34859,6 +34968,7 @@ paths:
|
||||
required:
|
||||
- id
|
||||
- secret
|
||||
- scope
|
||||
- name
|
||||
- owner
|
||||
- created
|
||||
|
||||
Reference in New Issue
Block a user