#%RAML 0.8 title: API Management API baseUri: https://apistg.np.covapp.io/apimanage/v1 protocols: - HTTPS schemas: - resourceReference: | { "id" : "http://api.covisint.com/schema/resourceReference", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Schema representing links", "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the resource.", "required": true }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } } } - namedResourceReference: "{\n \"id\" : \"http://api.covisint.com/schema/namedScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the basic resource reference and adds internationalized name and description.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceReference#\"\n \ },\n \"properties\" : {\n \"name\" : { \n \"description\": \"Internationalized resource name.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"description\" : { \n \"description\": \"Internationalized resource description.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }\n }\n}\n" - resource: | { "id" : "http://api.covisint.com/schema/resource", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Core schema", "definitions" : { "resource" : { "id" : "resource", "type" : "object", "description" : "A basic resource.", "properties" : { "id" : { "type" : "string", "maxLength" : 64, "description" : "The unique identifier for this resource.", "required": true }, "version": { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.", "required": false }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "required": true, "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "required": true, "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "required": true, "readonly": true } } } } } - resourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/resourceV2\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Core schema\",\n \ \"definitions\" : {\n \"resource\" : {\n \"id\" : \"resourceV2\",\n \ \"type\" : \"object\",\n \"description\" : \"A basic resource (version V2).\",\n \"properties\" : {\n \"id\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The unique identifier for this resource.\",\n \"required\": true\n },\n \"version\": {\n \"type\" : \"string\",\n \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.\",\n \"required\": false\n },\n \"creator\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.\",\n \"required\": true,\n \ \"readonly\": true\n },\n \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.\",\n \"required\": true,\n \"readonly\": true\n },\n \ \"creation\" : {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.\",\n \ \"required\": true,\n \"readonly\": true\n }\n }\n \ }\n } \n}\n" - realmScopedResource: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the base resource and adds a realm attribute.\",\n \ \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resource#\"\n \ },\n \"properties\" : {\n \"realm\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.\",\n \"required\": true,\n \"readonly\": true \n \ }\n }\n}\n" - realmScopedResourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResourceV2\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A realm scoped resource (version V2). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceV2#\"\n },\n \"properties\" : {\n \ \"realm\" : {\n \"type\" : \"string\",\n \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.\",\n \"required\": true,\n \"readonly\": true \n }\n }\n} \n" - errorResponseSchema: "{\n \"id\" : \"http://api.covisint.com/schema/errorResponseSchema\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Representation of an HTTP 4xx/5xx error response.\",\n \"properties\" : {\n \"status\" : { \n \"type\" : \"number\",\n \"minimum\" : 400,\n \ \"maximum\" : 599,\n \"description\" : \"The HTTP status code.\",\n \ \"required\": true\n },\n \"apiMessage\" : { \n \"type\" : \"string\",\n \ \"description\" : \"A helpful, human-readable description of the error, useful for basic diagnostics.\" \n },\n \"apiStatusCode\" : {\n \"type\" : \"string\",\n \"description\" : \"The API-specific status code.\"\n }\n \ }\n}\n" - serviceCode: "{\n \"id\" : \"http://api.covisint.com/schema/serviceCodes\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\": \"object\",\n \"description\": \"The site/service/location codes granted along with a service.\",\n \"properties\": {\n \"code\": { \"type\": \"string\", \"required\": true, \"maxLength\": 200, \"description\": \"The code value.\" },\n \"codeKind\": { \"type\": \"string\", \"required\": true, \"maxLength\": 36, \"description\": \"The associated business unit.\" }\n }\n} \n" - serviceCodes: | { "type" : "array", "description" : "The site/service/location codes granted along with the service, if any.", "items" : { "$ref" : "http://api.covisint.com/schema/serviceCode#"}, "required": false } - address: | { "id" : "http://api.covisint.com/idm/schema/address", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for the subject's address elements.", "properties" : { "type" : "string", "streets" : { "type" : "array", "description" : "An array of address streets (i.e. address line 1, 2, 3).", "minItems" : 0, "items" : { "type": "string", "maxLength" : 255 } }, "city" : { "type" : "string", "maxLength" : 60, "description" : "The city name." }, "state" : { "type" : "string", "maxLength" : 60, "description" : "The state/province name or code." }, "postal" : { "type" : "string", "maxLength" : 10, "description" : "The postal or zip code." }, "country" : { "type" : "string", "minLength" : 2, "maxLength" : 3, "description" : "The ISO country code. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"} } } - phone: "{\n \"id\" : \"http://api.covisint.com/idm/schema/phone\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"A container for phone number details.\",\n \"properties\" : {\n \"number\" : { \"type\" : \"string\",\"maxLength\" : 100, \"description\" : \"The phone number.\" },\n \"type\" : { \"enum\" : [ \"main\", \"mobile\", \"fax\" ], \"description\" : \"The phone number type.\" }\n },\n \"required\" : [ \"type\" ]\n} \n" - internationalString: | { "id": "http://api.covisint.com/idm/schema/internationalString", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "An internationalized string value, supporting one or more language translations.", "minItems": 1, "items": { "type": "object", "properties": { "lang": { "type": "string", "maxLength": 10, "description": "The language or locale in which the text is written." }, "text": { "type": "string", "maxLength": 2000, "description": "The internationalized text value." } } } } - tags: | { "id": "http://api.covisint.com/idm/schema/tag", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "The tags associated with a resource. This array is read-only, and may be modified on the resource endpoint with the appropriate tagging APIs.", "minItems": 1, "items": { "type": "object", "properties": { "tagName": { "type": "string", "description": "The tag associated with a resource." } } } } - baseDefinitionResource: "{\n \"id\" : \"http://api.covisint.com/schema/baseDefinitionResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A base rule definition(version V1). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\": {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResourceV2#\"\n },\n \"properties\": {\n \"name\": {\n \"description\": \"The application name (internationalized).\",\n \ \"required\": true,\n \"$ref\": \"http://api.covisint.com/schema/internationalString#\"\n \ },\n \"description\": {\n \"required\": false,\n \"description\": \"The application description (internationalized).\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }, \n \"properties\":{\n \"type\":\"array\",\n \"description\":\"Properties used by the implementation.\",\n \"required\":false,\n \"minItems\":0,\n \ \"items\":[ \n { \n \"anyOf\": [\n {\n \ \"type\": \"string\",\n \"description\": \"The name of the property.\",\n \"required\": true\n },\n \ {\n \"type\": \"string\",\n \"description\": \"The value of the property.\",\n \"required\": true\n }\n \ ]\n }\n ]\n }\n }\n}\n" - baseActionDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseActionDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action action definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of action definition.", "enum": [ "SEND_APPLICATION_NOTIFICATION", "SEND_COMMAND", "SEND_NOTIFICATION" ], "required": true } } } - baseTriggerDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseTriggerDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action trigger definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of trigger definition.", "enum": [ "DEVICE_SEND_EVENT", "DEVICE_LIFECYCLE_STATE_CHANGE", "DEVICE_OPERATIONAL_STATE_CHANGE" ], "required": true } } } - clientApplication: "{\n \"id\" : \"http://api.covisint.com/schema/clientApplication\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Schema representing a client applicaton of the Covisint APIs.\",\n \"properties\" : { \n \"clientId\": {\n \"description\": \"The unique identifier of the client. Also used for the user id in basic authentication.\",\n \ \"type\": \"string\",\n \"readOnly\":true\n },\n \"name\": {\n \ \"description\": \"The name of the client application.\",\n \"type\" : \"string\",\n \"required\":true\n },\n \"description\": {\n \"description\": \"The description of the client application.\",\n \"type\" : \"string\",\n \ \"required\":true\n },\n \"solutionInstanceId\": {\n \"description\": \"The ID of the solution instance the client application belongs to.\",\n \"type\" : \"string\",\n \"readOnly\":true\n },\n \"clientSecret\": {\n \"description\": \"The client secret. This is used as the password in basic authentication. This will not be included in the represenation by default. To include use the filter includeSecret=true.\",\n \"type\": \"string\",\n \"required\":false,\n \ \"readOnly\":true\n }\n }\n}\n" - oauth.configuration: "{\n \"id\" : \"http://api.covisint.com/schema/oauth.configuration\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Schema representing an oauth configuration for a client of the APIs\",\n \"properties\" : { \n \"accessTokenLifetime\": {\n \"description\": \"The oauth access token lifetime, in seconds.\",\n \ \"type\" : \"number\",\n \"minimum\" : 60,\n \"maximum\" : 31536000,\n \ \"required\":false\n },\n \"refreshTokenLifetime\": {\n \"description\": \"The oauth refresh token lifetime, in seconds.\",\n \"type\" : \"number\",\n \ \"minimum\" : 60,\n \"maximum\" : 31536000,\n \"required\":false\n \ },\n \"redirectUri\": {\n \"description\": \"The oauth redirect URI.\",\n \ \"type\": \"string\",\n \"required\":false\n },\n \"imageUrl\": {\n \"description\": \"The URL of the image to use for the Oauth consent form.\",\n \"type\": \"string\",\n \"required\":false\n },\n \"active\":{\n \ \"type\" : \"boolean\",\n \"description\": \"Indicates whether the API access is active. This can be changed through the /tasks/activate and /tasks/deactivate endpoints.\",\n \"required\": false,\n \"readOnly\": true\n }\n }\n}\n" - oauth.scopes: | { "id" : "http://api.covisint.com/schema/oauth.scopes", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "The allowed scopes.", "properties": { "allowedScopes": { "description": "The space-delimited list of allowed scopes.", "type": "string", "required":true }, "defaultScope": { "description": "The default scope. This is used when no scope is specified for an API and scope is required. Must be one of the scopes in allowedScopes.", "type": "string", "required":true } } } - oauth.scopeDescriptions: | { "id" : "http://api.covisint.com/schema/oauth.scopeDescriptions", "schema" : "http://json-schema.org/draft-04/schema", "description" : "Multi-lingual descriptions of OAuth scopes.", "properties": { "lang": { "description": "Language code for the language of the descriptions. Must be a valid 2-character ISO 639 language code. This field is absent for the default description, which is used when a description in the contextual language does not exist.", "type": "string", "minLength": "2", "maxLength": "2", "required": false, "readOnly": true }, "scopeDescriptions": { "type": "array", "minItems": 1, "required": true, "description": "The attributes associated with this group.", "items": { "type": "object", "properties": { "scope": { "type": "string", "description": "The scope.", "required": true }, "description": { "type": "string", "description": "The description for the scope.", "required": true } } } } } } traits: - secured: usage: Apply this to any method that needs to be secured. Requests with this trait require authentication using a bearer token. headers: Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk required: true responses: 401: &6 description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 403: &7 description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema - unsecured: usage: Apply this to any method that needs to be unsecured. Requests with this trait does not require any authentication. headers: SolutionInstanceId: description: The solution instance id. example: ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk required: true responses: 400: description: Bad request. Please provide the valid solution instance id. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema - getResponse: responses: 404: &3 description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 406: &1 description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: &2 description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema - getSearchResponse: responses: 406: *1 500: *2 - postResponse: responses: 406: *1 415: &4 description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: *2 - deleteResponse: responses: 500: *2 - putResponse: responses: 404: *3 406: *1 409: &5 description: | There is a conflict in identifying the resource being acted on. There are two categories. (1) The unique identifier in the URL and in the body are different. (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 415: *4 500: *2 - putResponseV2: responses: 404: *3 406: *1 409: description: | There is a conflict in identifying the resource being acted on. The unique identifier in the URL and body are different. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 415: *4 500: *2 - putCreateResponse: responses: 406: *1 409: *5 415: *4 500: *2 - taskResponse: responses: 401: *6 403: *7 500: *2 - pagableRequest: queryParameters: page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false minimum: 1 default: 1 pageSize: description: How many items per page in the paginated results. type: integer required: false minimum: 1 default: 50 maximum: 200 - taggable: queryParameters: tag: description: Get the resource based on specified tag. Multiple parameters are allowed and the search results will be a union. type: string required: false - sortable: queryParameters: sortBy: description: Sort the results based on some criteria. example: +creation, -name (These will sort by creation ascending, name descending. If "+/-" prefix is omitted, then an ascending sort is assumed). type: string required: false - searchable: description: Search resources based on the given filter parameters. Search is case-insensitive. <> <> "/solutionInstances/{solutionInstanceId}/clientApplications": is: - secured description: Collection endpoint for client applications. post: is: - postResponse description: Creates a new client application. The client application's client id will be returned in the response. headers: Accept: description: Media type. example: application/vnd.com.covisint.api.clientApplication.v1+json type: string required: true body: application/vnd.com.covisint.api.clientApplication.v1+json: schema: clientApplication responses: 201: description: A new client application was created and is returned in the body. body: application/vnd.com.covisint.api.clientApplication.v1+json: schema: clientApplication 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + apimanage.invalid.iso.language.code - The following language codes are invalid: {languageCode(s)} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema get: is: - getSearchResponse description: Search client applications. headers: Accept: description: 'Media type. Supported filters: includeSecret (boolean,default=false).' example: application/vnd.com.covisint.api.clientApplication.v1+json;includeSecret=true type: string required: true responses: 200: description: All client applications were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.api.clientApplication.v1+json: schema: clientApplication 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/{clientId}": description: Endpoint for an individual client application. uriParameters: clientId: description: Unique client identifier. type: string required: true is: - secured get: is: - getResponse description: Returns a client application by its unique identifier. headers: Accept: description: 'Media type. Supported filters: includeSecret (boolean,default=false).' example: application/vnd.com.covisint.api.clientApplication.v1+json;includeSecret=true type: string required: true responses: 200: description: The client application was successfully retrieved. body: application/vnd.com.covisint.api.clientApplication.v1+json: schema: clientApplication 400: description: | There was a problem with the client's request body: application/vnd.com.covisint.api.clientApplication.v1+json: schema: clientApplication put: is: - putResponse description: Updates an existing client application. headers: Accept: description: Media type. example: application/vnd.com.covisint.api.clientApplication.v1+json type: string required: true body: application/vnd.com.covisint.api.clientApplication.v1+json: schema: clientApplication responses: 200: description: The client application was successfully updated. body: application/vnd.com.covisint.api.clientApplication.v1+json: schema: clientApplication 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + group.invalid.iso.language.code - The following language codes are invalid: {languageCode(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: is: - deleteResponse description: Deletes a client application. headers: responses: 204: description: The client application was successfully deleted. 400: description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/oauthConfiguration": is: - secured description: Endpoint for a client application's OAuth configuration get: is: - getResponse description: Returns a client application's OAuth configuration headers: Accept: description: Media type. example: application/vnd.com.covisint.api.oauth.configuration.v1+json type: string required: true responses: 200: description: The OAuth configuration was successfully retrieved. body: application/vnd.com.covisint.api.oauth.configuration.v1+json: schema: oauth.configuration 400: description: | There was a problem with the client's request body: application/vnd.com.covisint.api.oauth.configuration.v1+json: schema: oauth.configuration put: is: - putResponse description: Updates a client application's OAuth configuration. headers: Accept: description: Media type. example: application/vnd.com.covisint.api.oauth.configuration.v1+json type: string required: true body: application/vnd.com.covisint.api.oauth.configuration.v1+json: schema: oauth.configuration responses: 200: description: The OAuth configuration was successfully updated. body: application/vnd.com.covisint.api.oauth.configuration.v1+json: schema: oauth.configuration 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + group.invalid.iso.language.code - The following language codes are invalid: {languageCode(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/scopes": is: - secured description: Endpoint for a client application's OAuth scopes get: is: - getResponse description: Returns a client application's OAuth scopes headers: Accept: description: Media type. example: application/vnd.com.covisint.api.oauth.scopes.v1+json type: string required: true responses: 200: description: The OAuth scopes were successfully retrieved. body: application/vnd.com.covisint.oauth.scopes.v1+json: schema: oauth.scopes 400: description: | There was a problem with the client's request body: application/vnd.com.covisint.api.oauth.scopes.v1+json: schema: oauth.scopes put: is: - putResponse description: Updates an existing client application's OAuth scopes. The scopes must be consistent with the scopes defined in the solution instance. headers: Accept: description: Media type. example: application/vnd.com.covisint.api.oauth.scopes.v1+json type: string required: true body: application/vnd.com.covisint.api.oauth.scopes.v1+json: schema: oauth.scopes responses: 200: description: The client application's scopes were successfully updated. body: application/vnd.com.covisint.api.oauth.configuration.v1+json: schema: oauth.configuration 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + group.invalid.iso.language.code - The following language codes are invalid: {languageCode(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/solutionInstances/{solutionInstanceId}/oauthConfiguration": is: - secured description: Endpoint for a solution instance's OAuth configuration get: is: - getResponse description: Returns a solution instance's OAuth configuration headers: Accept: description: Media type. example: application/vnd.com.covisint.api.oauth.configuration.v1+json type: string required: true responses: 200: description: The OAuth configuration was successfully retrieved. body: application/vnd.com.covisint.api.oauth.configuration.v1+json: schema: oauth.configuration 400: description: | There was a problem with the client's request body: application/vnd.com.covisint.api.oauth.configuration.v1+json: schema: oauth.configuration put: is: - putResponse description: Updates an existing solution instance's OAuth configuration. headers: Accept: description: Media type. example: application/vnd.com.covisint.api.oauth.configuration.v1+json type: string required: true body: application/vnd.com.covisint.api.oauth.configuration.v1+json: schema: oauth.configuration responses: 200: description: The solution instance's OAuth configuration was successfully updated. body: application/vnd.com.covisint.api.oauth.configuration.v1+json: schema: oauth.configuration 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + group.invalid.iso.language.code - The following language codes are invalid: {languageCode(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/solutionInstances/{solutionInstanceId}/scopes": is: - secured description: Endpoint for a solution instance's OAuth scopes get: is: - getResponse description: Returns a solution instance's OAuth scopes headers: Accept: description: Media type. example: application/vnd.com.covisint.api.oauth.scopes.v1+json type: string required: true responses: 200: description: The OAuth configuration was successfully retrieved. body: application/vnd.com.covisint.oauth.scopes.v1+json: schema: oauth.scopes 400: description: | There was a problem with the client's request body: application/vnd.com.covisint.api.oauth.scopes.v1+json: schema: oauth.scopes put: is: - putResponse description: Updates an existing solution instance's OAuth scopes. headers: Accept: description: Media type. example: application/vnd.com.covisint.api.oauth.scopes.v1+json type: string required: true body: application/vnd.com.covisint.api.oauth.scopes.v1+json: schema: oauth.scopes responses: 200: description: The solution instance was successfully updated. body: application/vnd.com.covisint.api.oauth.configuration.v1+json: schema: oauth.configuration 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + group.invalid.iso.language.code - The following language codes are invalid: {languageCode(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/solutionInstances/{solutionInstanceId}/scopeDescriptions/default": is: - secured description: Endpoint for a solution instance's default scope descriptions. get: is: - getResponse description: Returns a solution instance's default scope descriptions. headers: Accept: description: Media type. example: application/vnd.com.covisint.api.oauth.scopeDescriptions.v1+json type: string required: true responses: 200: description: The OAuth scope descriptions were successfully retrieved. body: application/vnd.com.covisint.api.oauth.scopeDescriptions.v1+json: schema: oauth.scopeDescriptions 400: description: | There was a problem with the client's request body: application/vnd.com.covisint.api.oauth.scopeDescriptions.v1+json: schema: oauth.configuration put: is: - putResponse description: Updates a solution instance's default scope descriptions. headers: Accept: description: Media type. example: application/vnd.com.covisint.api.oauth.scopeDescriptions.v1+json type: string required: true body: application/vnd.com.covisint.api.oauth.scopeDescriptions.v1+json: schema: oauth.scopeDescriptions responses: 200: description: The oauth scope descriptions were successfully updated. body: application/vnd.com.covisint.api.oauth.scopeDescriptions.v1+json: schema: oauth.scopeDescriptions 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + group.invalid.iso.language.code - The following language codes are invalid: {languageCode(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema