Laravel Server Credentials API
The Server Credentials API from Laravel — 2 operation(s) for server credentials.
OpenAPI Specification
openapi: 3.1.0
info:
title: Laravel Cloud Applications Server Credentials API
version: 0.0.1
servers:
- url: https://cloud.laravel.com/api
security:
- http: []
tags:
- name: Server Credentials
paths:
/orgs/{organization}/teams/{team}/server-credentials:
get:
operationId: organizations.teams.server-credentials.index
description: 'Show all server credentials for the team.
Processing mode: <small><code>sync</code></small>'
summary: List team server credentials
tags:
- Server Credentials
parameters:
- name: organization
in: path
required: true
description: The organization slug
schema:
type: string
- name: team
in: path
required: true
description: The team ID
schema:
type: integer
- name: page[size]
in: query
description: The number of results that will be returned per page.
schema:
type: integer
default: 30
- name: page[cursor]
in: query
description: The cursor to start the pagination from.
schema:
type: string
responses:
'200':
description: Paginated set of `ServerCredentialResource`
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ServerCredentialResource'
links:
type: object
properties:
first:
type: string
last:
type: string
prev:
type: string
next:
type: string
meta:
type: object
properties:
path:
type:
- string
- 'null'
description: Base path for paginator generated URLs.
per_page:
type: integer
description: Number of items shown per page.
minimum: 0
next_cursor:
type:
- string
- 'null'
description: The "cursor" that points to the next set of items.
prev_cursor:
type:
- string
- 'null'
description: The "cursor" that points to the previous set of items.
required:
- path
- per_page
- next_cursor
- prev_cursor
required:
- data
- links
- meta
'404':
$ref: '#/components/responses/ModelNotFoundException'
'403':
$ref: '#/components/responses/AuthorizationException'
security:
- oauth2:
- credential:view
x-permissions:
- credential:view
x-mint:
metadata:
noindex: true
x-processingMode: sync
post:
operationId: organizations.teams.server-credentials.store
description: 'Share a server credential with a team.
Processing mode: <small><code>sync</code></small>'
summary: Create a new server credential share
tags:
- Server Credentials
parameters:
- name: organization
in: path
required: true
description: The organization slug
schema:
type: string
- name: team
in: path
required: true
description: The team ID
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ShareCredentialRequest'
responses:
'201':
description: '`ServerCredentialResource`'
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/ServerCredentialResource'
required:
- data
'404':
$ref: '#/components/responses/ModelNotFoundException'
'403':
$ref: '#/components/responses/AuthorizationException'
'422':
$ref: '#/components/responses/ValidationException'
security:
- oauth2:
- credential:manage
- credential:view
x-permissions:
- credential:manage
- credential:view
x-mint:
metadata:
noindex: true
x-processingMode: sync
/orgs/{organization}/teams/{team}/server-credentials/{credential}:
delete:
operationId: organizations.teams.server-credentials.destroy
description: 'Unshare a server credential with a team.
Processing mode: <small><code>sync</code></small>'
summary: Delete a server credential share
tags:
- Server Credentials
parameters:
- name: organization
in: path
required: true
description: The organization slug
schema:
type: string
- name: team
in: path
required: true
description: The team ID
schema:
type: integer
- name: credential
in: path
required: true
description: The credential ID
schema:
type: integer
responses:
'204':
description: 'Server credential unshared successfully
No content'
'404':
$ref: '#/components/responses/ModelNotFoundException'
'403':
$ref: '#/components/responses/AuthorizationException'
security:
- oauth2:
- credential:manage
- credential:view
x-permissions:
- credential:manage
- credential:view
x-mint:
metadata:
noindex: true
x-processingMode: sync
components:
schemas:
ServerCredentialResource:
type: object
properties:
id:
type: string
type:
type: string
enum:
- serverCredentials
attributes:
type: object
properties:
name:
type: string
provider:
type: string
in_use:
type: boolean
created_at:
type:
- string
- 'null'
format: date-time
updated_at:
type:
- string
- 'null'
format: date-time
required:
- name
- provider
- in_use
- created_at
- updated_at
links:
type: object
properties:
self:
$ref: '#/components/schemas/Link'
required:
- self
required:
- id
- type
- links
title: ServerCredentialResource
Link:
type: object
properties:
href:
type: string
format: uri
rel:
type: string
describedby:
type: string
title:
type: string
type:
type: string
hreflang:
anyOf:
- type: string
- type: array
items:
type: string
meta:
type: object
required:
- href
title: Link
ShareCredentialRequest:
type: object
properties:
credential_id:
type: integer
required:
- credential_id
title: ShareCredentialRequest
responses:
ModelNotFoundException:
description: Not found
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Error overview.
required:
- message
ValidationException:
description: Validation error
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Errors overview.
errors:
type: object
description: A detailed description of each field that failed validation.
additionalProperties:
type: array
items:
type: string
required:
- message
- errors
AuthorizationException:
description: Authorization error
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Error overview.
required:
- message
securitySchemes:
http:
type: http
description: The Bearer Token generated on the Cloud UI.
scheme: bearer
bearerFormat: bearer