Cloudsmith orgs API
The orgs API from Cloudsmith — 40 operation(s) for orgs.
The orgs API from Cloudsmith — 40 operation(s) for orgs.
swagger: '2.0'
info:
title: Cloudsmith API (v1) audit-log orgs API
description: The API to the Cloudsmith Service
termsOfService: https://help.cloudsmith.io
contact:
name: Cloudsmith Support
url: https://help.cloudsmith.io
email: support@cloudsmith.io
license:
name: MIT
url: https://opensource.org/licenses/MIT
version: v1
host: api.cloudsmith.io
basePath: /
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- apikey: []
- basic: []
tags:
- name: orgs
paths:
/orgs/:
parameters: []
get:
operationId: orgs_list
summary: Get a list of all the organizations you are associated with.
description: Get a list of all the organizations you are associated with.
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/Organization'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/:
parameters:
- name: org
in: path
required: true
type: string
get:
operationId: orgs_read
summary: Get the details for the specific organization.
description: Get the details for the specific organization.
parameters: []
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Organization'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
delete:
operationId: orgs_delete
summary: Delete the specified organization.
description: Delete the specified organization.
parameters: []
responses:
'204':
description: No Content
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/deny-policy/:
parameters:
- name: org
in: path
required: true
type: string
get:
operationId: orgs_deny-policy_list
summary: Get a list of all package deny policies.
description: Get a list of all package deny policies.
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/PackageDenyPolicy'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
post:
operationId: orgs_deny-policy_create
summary: Create a package deny policy.
description: Create a package deny policy.
parameters:
- name: data
in: body
required: false
schema:
$ref: '#/definitions/PackageDenyPolicyRequest'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/PackageDenyPolicy'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/deny-policy/{slug_perm}/:
parameters:
- name: org
in: path
required: true
type: string
- name: slug_perm
in: path
required: true
type: string
get:
operationId: orgs_deny-policy_read
summary: Get a package deny policy.
description: Get a package deny policy.
parameters: []
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PackageDenyPolicy'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
put:
operationId: orgs_deny-policy_update
summary: Update a package deny policy.
description: Update a package deny policy.
parameters:
- name: data
in: body
required: false
schema:
$ref: '#/definitions/PackageDenyPolicyRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PackageDenyPolicy'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
patch:
operationId: orgs_deny-policy_partial_update
summary: Partially update a package deny policy.
description: Partially update a package deny policy.
parameters:
- name: data
in: body
required: false
schema:
$ref: '#/definitions/PackageDenyPolicyRequestPatch'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PackageDenyPolicy'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
delete:
operationId: orgs_deny-policy_delete
summary: Delete a package deny policy.
description: Delete a package deny policy.
parameters: []
responses:
'204':
description: No Content
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/invites/:
parameters:
- name: org
in: path
required: true
type: string
get:
operationId: orgs_invites_list
summary: Get a list of all invites for an organization.
description: Get a list of all invites for an organization.
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
type: integer
responses:
'200':
description: Retrieved the list of organization invites
schema:
type: array
items:
$ref: '#/definitions/OrganizationInvite'
'404':
description: Organization invites not found
schema:
$ref: '#/definitions/ErrorDetail'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
post:
operationId: orgs_invites_create
summary: Create an organization invite for a specific user
description: Create an organization invite for a specific user
parameters:
- name: data
in: body
required: false
schema:
$ref: '#/definitions/OrganizationInviteRequest'
responses:
'201':
description: Invite sent
schema:
$ref: '#/definitions/OrganizationInvite'
'400':
description: The invite cannot be created.
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/invites/{slug_perm}/:
parameters:
- name: org
in: path
required: true
type: string
- name: slug_perm
in: path
required: true
type: string
patch:
operationId: orgs_invites_partial_update
summary: Update a specific organization invite.
description: Update a specific organization invite.
parameters:
- name: data
in: body
required: false
schema:
$ref: '#/definitions/OrganizationInviteUpdateRequestPatch'
responses:
'200':
description: Invite updated
schema:
$ref: '#/definitions/OrganizationInvite'
'400':
description: The invite cannot be updated.
schema:
$ref: '#/definitions/ErrorDetail'
'404':
description: Invite not found.
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
delete:
operationId: orgs_invites_delete
summary: Delete a specific organization invite
description: Delete a specific organization invite
parameters: []
responses:
'204':
description: Deleted the organization invite successfully.
'400':
description: The organization invite cannot be deleted.
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/invites/{slug_perm}/extend/:
parameters:
- name: org
in: path
required: true
type: string
- name: slug_perm
in: path
required: true
type: string
post:
operationId: orgs_invites_extend
summary: Extend an organization invite.
description: Extend an organization invite.
parameters: []
responses:
'200':
description: The invite has been extended
schema:
$ref: '#/definitions/OrganizationInviteExtend'
'404':
description: Invite not found.
schema:
$ref: '#/definitions/ErrorDetail'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/invites/{slug_perm}/resend/:
parameters:
- name: org
in: path
required: true
type: string
- name: slug_perm
in: path
required: true
type: string
post:
operationId: orgs_invites_resend
summary: Resend an organization invite.
description: Resend an organization invite.
parameters: []
responses:
'200':
description: The invite has been resent
schema:
$ref: '#/definitions/OrganizationInviteExtend'
'404':
description: Invite not found.
schema:
$ref: '#/definitions/ErrorDetail'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/license-policy-violation/:
parameters:
- name: org
in: path
required: true
type: string
get:
operationId: orgs_license-policy-violation_list
summary: List all current license policy violations for this Organization.
description: List all current license policy violations for this Organization.
parameters:
- name: cursor
in: query
description: The pagination cursor value.
required: false
type: string
- name: page_size
in: query
description: Number of results to return per page.
required: false
type: integer
responses:
'200':
description: OK
schema:
required:
- results
type: object
properties:
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/PackageLicensePolicyViolationLog'
title: PackageLicensePolicyViolationLogCursorPage
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/license-policy/:
parameters:
- name: org
in: path
required: true
type: string
get:
operationId: orgs_license-policy_list
summary: Get a list of all package license policies.
description: Get a list of all package license policies.
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/OrganizationPackageLicensePolicy'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
post:
operationId: orgs_license-policy_create
summary: Create a package license policy.
description: Create a package license policy.
parameters:
- name: data
in: body
required: false
schema:
$ref: '#/definitions/OrganizationPackageLicensePolicyRequest'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/OrganizationPackageLicensePolicy'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/license-policy/{policy_slug_perm}/evaluation/:
parameters:
- name: org
in: path
required: true
type: string
- name: policy_slug_perm
in: path
required: true
type: string
get:
operationId: orgs_license-policy_evaluation_list
summary: List evaluation requests for this policy.
description: List evaluation requests for this policy.
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/PackageLicensePolicyEvaluationRequest'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
post:
operationId: orgs_license-policy_evaluation_create
summary: Create an evaluation request for this policy.
description: Create an evaluation request for this policy.
parameters:
- name: data
in: body
required: false
schema:
$ref: '#/definitions/PackageLicensePolicyEvaluationRequestRequest'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/PackageLicensePolicyEvaluationRequest'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/license-policy/{policy_slug_perm}/evaluation/{slug_perm}/:
parameters:
- name: org
in: path
required: true
type: string
- name: policy_slug_perm
in: path
required: true
type: string
- name: slug_perm
in: path
required: true
type: string
get:
operationId: orgs_license-policy_evaluation_read
summary: Retrieve an evaluation request for this policy.
description: Retrieve an evaluation request for this policy.
parameters: []
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PackageLicensePolicyEvaluationRequest'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/license-policy/{slug_perm}/:
parameters:
- name: org
in: path
required: true
type: string
- name: slug_perm
in: path
required: true
type: string
get:
operationId: orgs_license-policy_read
summary: Get a package license policy.
description: Get a package license policy.
parameters: []
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OrganizationPackageLicensePolicy'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
put:
operationId: orgs_license-policy_update
summary: Update a package license policy.
description: Update a package license policy.
parameters:
- name: data
in: body
required: false
schema:
$ref: '#/definitions/OrganizationPackageLicensePolicyRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OrganizationPackageLicensePolicy'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
patch:
operationId: orgs_license-policy_partial_update
summary: Partially update a package license policy.
description: Partially update a package license policy.
parameters:
- name: data
in: body
required: false
schema:
$ref: '#/definitions/OrganizationPackageLicensePolicyRequestPatch'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OrganizationPackageLicensePolicy'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
delete:
operationId: orgs_license-policy_delete
summary: Delete a package license policy.
description: Delete a package license policy.
parameters: []
responses:
'204':
description: No Content
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/members/:
parameters:
- name: org
in: path
required: true
type: string
get:
operationId: orgs_members_list
summary: Get the details for all organization members.
description: Get the details for all organization members.
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
type: integer
- name: is_active
in: query
description: Filter for active/inactive users.
required: false
type: boolean
default: false
- name: query
in: query
description: 'A search term for querying of members within an Organization.Available options are: email, org, user, userslug, inactive, user_name, role'
required: false
type: string
default: ''
- name: sort
in: query
description: 'A field for sorting objects in ascending or descending order. Use `-` prefix for descending order (e.g., `-user_name`). Available options: user_name, role.'
required: false
type: string
default: user_name
responses:
'200':
description: Retrieved the list of organization's members
schema:
type: array
items:
$ref: '#/definitions/OrganizationMembership'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/members/{member}/:
parameters:
- name: org
in: path
required: true
type: string
- name: member
in: path
required: true
type: string
get:
operationId: orgs_members_read
summary: Get the details for a specific organization member.
description: Get the details for a specific organization member.
parameters: []
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OrganizationMembership'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
patch:
operationId: orgs_members_partial_update
summary: Views for working with organization members.
description: Views for working with organization members.
parameters:
- name: data
in: body
required: false
schema:
$ref: '#/definitions/OrganizationMembershipRequestPatch'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OrganizationMembership'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
delete:
operationId: orgs_members_delete
summary: Removes a member from the organization.
description: Removes a member from the organization.
parameters: []
responses:
'204':
description: Removed the organization member successfully.
'400':
description: The organization member cannot be deleted.
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/members/{member}/refresh/:
parameters:
- name: org
in: path
required: true
type: string
- name: member
in: path
required: true
type: string
post:
operationId: orgs_members_refresh
summary: Refresh a member of the organization's API key.
description: Refresh a member of the organization's API key.
parameters: []
responses:
'204':
description: Org member API key has been refreshed.
'400':
description: The org member's API key cannot be refreshed.
schema:
$ref: '#/definitions/ErrorDetail'
'404':
description: Org member not found.
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/members/{member}/remove/:
parameters:
- name: org
in: path
required: true
type: string
- name: member
in: path
required: true
type: string
get:
operationId: orgs_members_remove
summary: Removes a member from the organization (deprecated, use DELETE instead).
description: Removes a member from the organization (deprecated, use DELETE instead).
parameters: []
responses:
'204':
description: Removed the organization member successfully.
'400':
description: The organization member cannot be deleted.
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/members/{member}/update-role/:
parameters:
- name: org
in: path
required: true
type: string
- name: member
in: path
required: true
type: string
patch:
operationId: orgs_members_update_role
summary: Update a member's role in the organization.
description: Update a member's role in the organization.
parameters:
- name: data
in: body
required: false
schema:
$ref: '#/definitions/OrganizationMembershipRoleUpdateRequestPatch'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OrganizationMembershipRoleUpdate'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/members/{member}/update-visibility/:
parameters:
- name: org
in: path
required: true
type: string
- name: member
in: path
required: true
type: string
patch:
operationId: orgs_members_update_visibility
summary: Update a member's visibility in the organization.
description: Update a member's visibility in the organization.
parameters:
- name: data
in: body
required: false
schema:
$ref: '#/definitions/OrganizationMembershipVisibilityUpdateRequestPatch'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OrganizationMembershipVisibilityUpdate'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
/orgs/{org}/openid-connect/:
parameters:
- name: org
in: path
required: true
type: string
get:
operationId: orgs_openid-connect_list
summary: Retrieve the list of OpenID Connect provider settings for the org.
description: Retrieve the list of OpenID Connect provider settings for the org.
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
type: integer
- name: query
in: query
description: 'A search term for querying of OpenID Connect (OIDC) provider settings.Available options are: name, provider_url, service_account'
required: false
type: string
default: ''
- name: sort
in: query
description: 'A field for sorting objects in ascending or descending order. Use `-` prefix for descending order (e.g., `-name`). Available options: name.'
required: false
type: string
default: name
responses:
'200':
description: Retrieved the list of OpenID Connect provider settings for the org
schema:
type: array
items:
$ref: '#/definitions/ProviderSettings'
'404':
description: Organization not found
schema:
$ref: '#/definitions/ErrorDetail'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- orgs
post:
operationId: orgs_openid-connect_create
summary: Create the OpenID Connect provider settings for the org.
description
# --- truncated at 32 KB (116 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudsmith/refs/heads/main/openapi/cloudsmith-orgs-api-openapi.yml