openapi: 3.2.0 info: title: Oracle Sender Invitation API version: '1.0' description: 'Operations tagged senderInvitation across 2 of this provider''s published API definitions: oci-organizations-1-openapi.yaml, oci-organizations-openapi.yaml. Each path carries the servers of the definition it was published in.' servers: - url: http://127.0.0.1/20220518 - url: https://127.0.0.1/20220518 tags: - name: senderInvitation paths: /senderInvitations: get: description: 'Return a (paginated) list of sender invitations. ' operationId: ListSenderInvitations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RecipientTenancyIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/SenderInvitationStatusQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: List of sender invitations. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SenderInvitationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists sender invitations tags: - senderInvitation x-related-resource: '#/definitions/SenderInvitation' post: description: Creates a sender invitation and asynchronously sends the invitation to the recipient. operationId: CreateSenderInvitation parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Sender invitation creation accepted. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SenderInvitation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a sender invitation and asynchronously sends the invitation to recipient. tags: - senderInvitation x-related-resource: '#/definitions/SenderInvitation' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSenderInvitationDetails' description: Parameters for sender invitation creation. required: true /senderInvitations/{senderInvitationId}: get: description: Gets information about the sender invitation. operationId: GetSenderInvitation parameters: - description: OCID of the sender invitation to retrieve. in: path name: senderInvitationId required: true schema: type: string maxLength: 255 - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Sender invitation retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SenderInvitation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets information about the sender invitation. tags: - senderInvitation put: description: Updates the sender invitation. operationId: UpdateSenderInvitation parameters: - description: OCID of the sender invitation to update. in: path name: senderInvitationId required: true schema: type: string maxLength: 255 - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Sender invitation updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SenderInvitation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the SenderInvitation identified by the id. tags: - senderInvitation x-related-resource: '#/definitions/SenderInvitation' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSenderInvitationDetails' description: The information to be updated. required: true /senderInvitations/{senderInvitationId}/actions/cancel: post: description: Cancels a sender invitation. operationId: CancelSenderInvitation parameters: - description: OCID of the sender invitation to cancel. in: path name: senderInvitationId required: true schema: type: string maxLength: 255 - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Sender invitation cancellation request accepted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancels a sender invitation. tags: - senderInvitation x-related-resource: '#/definitions/SenderInvitation' components: schemas: SenderInvitationSummary: description: The summary of the invitation model that the sender owns. properties: compartmentId: description: OCID of the sender tenancy. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A user-created name to describe the invitation. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: OCID of the sender invitation. maxLength: 255 minLength: 1 type: string invitationFeatures: description: List of features that the invitation is being sent for. Each feature would create one link, of that type. items: $ref: '#/components/schemas/InvitationFeature' maxItems: 10 type: array uniqueItems: true lifecycleState: description: Lifecycle state of the sender invitation. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - FAILED - TERMINATED example: ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' recipientEmailAddress: description: Email address of the recipient. maxLength: 255 minLength: 6 type: string recipientInvitationId: description: OCID of the corresponding recipient invitation. maxLength: 255 minLength: 1 type: string recipientTenancyId: description: OCID of the recipient tenancy. maxLength: 255 minLength: 1 type: string status: description: Status of the sender invitation. enum: - PENDING - CANCELED - ACCEPTED - EXPIRED - FAILED - NOT_APPLICABLE example: ACCEPTED type: string x-obmcs-top-level-enum: '#/definitions/SenderInvitationStatus' subjects: description: The list of subjects the invitation contains. items: $ref: '#/components/schemas/InvitationSubject' minItems: 1 type: array uniqueItems: true systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Date and time when the sender invitation was created. example: 2016-08-29 09:12:33.001000+00:00 format: date-time type: string timeUpdated: description: Date and time when the sender invitation was last updated. example: 2016-08-29 09:12:33.001000+00:00 format: date-time type: string required: - id - compartmentId - displayName - recipientTenancyId - lifecycleState - status - timeCreated - subjects InvitationSubject: description: A subject an invitation can contain. enum: - LINK - GOVERNANCE - EXTENDED_FEATURES type: string Error: description: Error information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message UpdateSenderInvitationDetails: description: The parameters for updating a sender invitation. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A user-created name to describe the invitation. Avoid entering confidential information. maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object InvitationFeature: description: The feature model for sender invitation. properties: name: description: Name of the feature. maxLength: 255 minLength: 1 type: string recipientInvitationId: description: recipientInvitationId for this feature. maxLength: 255 minLength: 1 type: string status: description: Status of the sender invitation. enum: - PENDING - CANCELED - ACCEPTED - EXPIRED - FAILED - NOT_APPLICABLE example: ACCEPTED type: string x-obmcs-top-level-enum: '#/definitions/SenderInvitationStatus' type: object SenderInvitation: description: The invitation model that the sender owns. properties: compartmentId: description: OCID of the sender tenancy. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A user-created name to describe the invitation. Avoid entering confidential information. example: test_name type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: OCID of the sender invitation. maxLength: 255 minLength: 1 type: string invitationFeatures: description: List of features that the invitation is being sent for. Each feature would create one link, of that type. items: $ref: '#/components/schemas/InvitationFeature' maxItems: 10 type: array uniqueItems: true lifecycleState: description: Lifecycle state of the sender invitation. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - FAILED - TERMINATED example: ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' recipientEmailAddress: description: Email address of the recipient. maxLength: 255 minLength: 6 type: string recipientInvitationId: description: OCID of the corresponding recipient invitation. maxLength: 255 minLength: 1 type: string recipientTenancyId: description: OCID of the recipient tenancy. maxLength: 255 minLength: 1 type: string status: description: Status of the sender invitation. enum: - PENDING - CANCELED - ACCEPTED - EXPIRED - FAILED - NOT_APPLICABLE example: ACCEPTED type: string x-obmcs-top-level-enum: '#/definitions/SenderInvitationStatus' subjects: description: The list of subjects the invitation contains. items: $ref: '#/components/schemas/InvitationSubject' minItems: 1 type: array uniqueItems: true systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Date and time when the sender invitation was created. example: 2016-08-29 09:12:33.001000+00:00 format: date-time type: string timeUpdated: description: Date and time when the sender invitation was last updated. example: 2016-08-29 09:12:33.001000+00:00 format: date-time type: string required: - id - compartmentId - recipientTenancyId - lifecycleState - status - timeCreated - subjects SenderInvitationCollection: description: Result of a query request for a list of sender invitations. Contains SenderInvitationSummary items. properties: items: description: Array containing SenderInvitationSummary items. items: $ref: '#/components/schemas/SenderInvitationSummary' type: array required: - items type: object CreateSenderInvitationDetails: description: The parameters for creating a sender invitation. properties: compartmentId: description: OCID of the sender tenancy. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A user-created name to describe the invitation. Avoid entering confidential information. maxLength: 255 type: string features: description: List of features that the invitation is being sent for. Each feature would create one link, of that type. example: - CORE items: maxLength: 64 minLength: 1 type: string maxItems: 10 type: array uniqueItems: true freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object recipientEmailAddress: description: Email address of the recipient. maxLength: 255 minLength: 6 type: string recipientTenancyId: description: OCID of the recipient tenancy. maxLength: 255 minLength: 1 type: string subjects: default: - LINK description: The list of subjects this invitation contains. items: $ref: '#/components/schemas/InvitationSubject' minItems: 1 type: array uniqueItems: true required: - compartmentId - recipientTenancyId parameters: PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page x-default-description: 'null' schema: type: string minLength: 1 SortByQueryParam: description: 'The field to sort by. Only one sort order can be provided. * The default order for timeCreated is descending. * The default order for displayName is ascending. * If no value is specified, timeCreated is the default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string maxLength: 255 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string RecipientTenancyIdQueryParam: description: The tenancy that the invitation is addressed to. in: query name: recipientTenancyId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 100 maximum: 1000 minimum: 1 SortOrderQueryParam: description: The sort order to use, whether 'asc' or 'desc'. in: query name: sortOrder x-default-description: The default order depends on what parameter is being sorted by. x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC SenderInvitationStatusQueryParam: description: The status of the sender invitation. in: query name: status x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/SenderInvitationStatus' schema: type: string enum: - PENDING - CANCELED - ACCEPTED - EXPIRED - FAILED - NOT_APPLICABLE RetryTokenHeader: description: 'A token that uniquely identifies a request, so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request will be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string LifecycleStateQueryParam: description: The lifecycle state of the resource. in: query name: lifecycleState x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/LifecycleState' schema: type: string enum: - CREATING - ACTIVE - INACTIVE - UPDATING - FAILED - TERMINATED responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-refined-from: - oci-organizations-1-openapi.yaml - oci-organizations-openapi.yaml x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.idm.agcs.cp