Jump to

• Request
• Response

createApplicationID

post

/ccadmin/v1/applicationIds

Create Application ID. Creates an Application ID of specified type

Request

Supported Media Types

• application/json

Body ()

Root Schema : createApplicationID_request

Type: object

Show Source

• lifetimeDays(optional): integer
  Only valid with type application. The lifetime in days for the generated auth token, after which the token will be invalid for login. If not set, or set to -1, the lifetime of the token will be unlimted. If set to 0, the token will be invalid for login. If set to a value over 365, then the value will be changed to 365.
• name: string
  The name for the new Application ID.
• type: string
  The Application ID type: application or extension.

{
    "properties":{
        "name":{
            "description":"The name for the new Application ID.",
            "type":"string"
        },
        "lifetimeDays":{
            "description":"Only valid with type application. The lifetime in days for the generated auth token, after which the token will be invalid for login. If not set, or set to -1, the lifetime of the token will be unlimted. If set to 0, the token will be invalid for login. If set to a value over 365, then the value will be changed to 365.",
            "type":"integer"
        },
        "type":{
            "description":"The Application ID type: application or extension.",
            "type":"string"
        }
    },
    "required":[
        "name",
        "type"
    ],
    "example":{
        "name":"exampleApp",
        "lifetimeDays":90,
        "type":"application"
    }
}

Example:

{
    "name":"exampleApp",
    "lifetimeDays":90,
    "type":"application"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createApplicationID_response

Type: object

Show Source

• createdBy(optional): object createdBy
  information about the user who created the application.
• creationTime(optional): string
  time application was created in ISO 8601 format.
• external(optional): boolean
  true if the application ID is external.
• inUse(optional): boolean
  true if the application ID is currently being used.
• name(optional): string
  the name of the application.
• repositoryId(optional): string
  the id of the application ID item.
• token(optional): string
  The auth token for the application, if of type application.
• type(optional): string
  the type of application; can be application or extension.

{
    "properties":{
        "external":{
            "description":"true if the application ID is external.",
            "type":"boolean"
        },
        "creationTime":{
            "description":"time application was created in ISO 8601 format.",
            "type":"string"
        },
        "createdBy":{
            "description":"information about the user who created the application.",
            "type":"object",
            "properties":{
                "lastName":{
                    "description":"last name of user.",
                    "type":"string"
                },
                "firstName":{
                    "description":"first name of the user.",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"the repository id of the user",
                    "type":"string"
                }
            }
        },
        "repositoryId":{
            "description":"the id of the application ID item.",
            "type":"string"
        },
        "name":{
            "description":"the name of the application.",
            "type":"string"
        },
        "inUse":{
            "description":"true if the application ID is currently being used.",
            "type":"boolean"
        },
        "type":{
            "description":"the type of application; can be application or extension.",
            "type":"string"
        },
        "token":{
            "description":"The auth token for the application, if of type application.",
            "type":"string"
        }
    }
}

Nested Schema : createdBy

Type: object

information about the user who created the application.

Show Source

• firstName(optional): string
  first name of the user.
• lastName(optional): string
  last name of user.
• repositoryId(optional): string
  the repository id of the user

{
    "description":"information about the user who created the application.",
    "type":"object",
    "properties":{
        "lastName":{
            "description":"last name of user.",
            "type":"string"
        },
        "firstName":{
            "description":"first name of the user.",
            "type":"string"
        },
        "repositoryId":{
            "description":"the repository id of the user",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "external":false,
    "creationTime":"2014-05-08 17:17:02.399",
    "createdBy":{
        "lastName":"Admin",
        "firstName":"Amber",
        "repositoryId":"admin",
        "id":"admin"
    },
    "inUse":false,
    "name":"another application name",
    "repositoryId":"12c26908-6545-4947-a46c-9917236583c5",
    "id":"12c26908-6545-4947-a46c-9917236583c5",
    "type":"application",
    "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MDk4NTY1OTEsInN1YiI6ImFkbWluIiwiaXNzIjoiYWRtaW4iLCJpYXQiOjE0MDk3NzAxOTF9.T0kaE8Ib35R2XZzp0xk4FRP/266KD1cieZFpPijtniw="
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top