{"items":[{"type":"link","label":"OpenAPI Specification","link":"/celonis-apis/team-api/openapi/openapi","routeSlug":"/celonis-apis/team-api/openapi/openapi","content":{"contentType":"overview","meta":{"name":"OpenAPI Specification"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/celonis-apis/team-api/openapi/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/celonis-apis/team-api/openapi/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"java","title":"Java","lang":"Java"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/celonis-apis/team-api/openapi/openapi","description":"Test Server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"OpenAPI Specification (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This is the documentation for the Team API, that allows querying data for a Celonis Platform team."}],"sectionId":"/celonis-apis/team-api/openapi/openapi"}],"sectionId":"/celonis-apis/team-api/openapi/openapi"}]}]}},{"type":"group","label":"Members API","link":"/celonis-apis/team-api/openapi/openapi/members-api","routeSlug":"/celonis-apis/team-api/openapi/openapi/members-api","items":[{"label":"List of all members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/celonis-apis/team-api/openapi/openapi/members-api/getmemberprofileexternaltransport","routeSlug":"/celonis-apis/team-api/openapi/openapi/members-api/getmemberprofileexternaltransport","metadata":{"seo":{"title":"List of all members","description":"Maximum number of members that will be received by page is 200. The OAuth 2.0 scope to use is team.user-group-info:read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMemberProfileExternalTransport","name":"List of all members","isWebhook":false,"pointer":"/paths/~1api~1external~1members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of members that will be received by page is 200."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The OAuth 2.0 scope to use is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tt","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"team.user-group-info:read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":"Prefix the Token with \"AppKey \" or \"Bearer \" (word and space) to indicate the Authorization type"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_128","description":"Page number to be retrieved. Starts with 0.","example":0},{"name":"pageSize","in":"query","schemaId":"schema_129","description":"Limit of results per page","example":200},{"name":"includeInternal","in":"query","schemaId":"schema_130","description":"A boolean parameter to show internal or external members","required":true,"example":true}],"pointer":"/paths/~1api~1external~1members/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/external/members","servers":[{"url":"/_mock/celonis-apis/team-api/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"example":0,"schemaId":"schema_128"},{"name":"pageSize","in":"query","required":false,"example":200,"schemaId":"schema_129"},{"name":"includeInternal","in":"query","required":true,"example":true,"schemaId":"schema_130"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","204","400","401","403","405","500"],"pointer":"/api/external/members","href":"members-api/getmemberprofileexternaltransport","openApiOperationId":"getMemberProfileExternalTransport","summary":"List of all members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/celonis-apis/team-api/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Members","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageTransportMemberProfileExternalTransport"}},"schemaId":"components/schemas/PageTransportMemberProfileExternalTransport"},{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request. Check the response contents for an explanation of the cause."},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. Check whether your API key or application key has sufficient permissions. If you are unsure, refer the documentation on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.celonis.com/en/creating-api-keys.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.celonis.com/en/creating-and-granting-permissions-to-application-keys.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"code":"403","description":"Forbidden"},{"code":"405","description":"Method Not Allowed"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An internal error happened. Forward the associated error ID along with any helpful information to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.celopeers.com/s/support?language=en_US"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"our support"},"children":[]}]}]}]}]}],"pointer":"/paths/~1api~1external~1members/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageTransportMemberProfileExternalTransport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageTransportMemberProfileExternalTransport"}}},{"code":"204"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"405"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/members-api/getmemberprofileexternaltransport"}],"panels":[]}]},"httpPath":"/api/external/members"}],"content":{"contentType":"group","meta":{"name":"Members API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Members API","showPageActions":true},{"nodeType":"markdoc","content":"Allows you to query and export a list of all members assigned to a Celonis Platform team."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/external/members","summary":"List of all members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/members-api/getmemberprofileexternaltransport","deprecated":false}]}]}]}]}},{"type":"group","label":"Login History API","link":"/celonis-apis/team-api/openapi/openapi/login-history-api","routeSlug":"/celonis-apis/team-api/openapi/openapi/login-history-api","items":[{"label":"List Login History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/celonis-apis/team-api/openapi/openapi/login-history-api/findallauthenticationevents","routeSlug":"/celonis-apis/team-api/openapi/openapi/login-history-api/findallauthenticationevents","metadata":{"seo":{"title":"List Login History","description":"Login History events can be filtered by specifying a date interval. Maximum number of events that will be received by page is 200.  The OAuth 2.0 scope to use is team.login-history:read. If there would be more events on the specified date interval total number of pages will be returned for further querying."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"findAllAuthenticationEvents","name":"List Login History","isWebhook":false,"pointer":"/paths/~1api~1external~1authentication-events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Login History","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Login History events can be filtered by specifying a date interval."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum number of events that will be received by page is 200. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The OAuth 2.0 scope to use is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tt","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"team.login-history:read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If there would be more events on the specified date interval total number of pages will be returned for further querying."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":"Prefix the Token with \"AppKey \" or \"Bearer \" (word and space) to indicate the Authorization type"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_128","description":"Page number to be retrieved, starts with 0","example":0},{"name":"pageSize","in":"query","schemaId":"schema_129","description":"Limit of results per page","example":200},{"name":"from","in":"query","schemaId":"schema_131","description":"Date Time ISO 8601 yyyy-MM-ddTHH:mm:ss","example":"2022-01-01T09:00:00"},{"name":"to","in":"query","schemaId":"schema_131","description":"Date Time ISO 8601 yyyy-MM-ddTHH:mm:ss","example":"2022-01-31T09:00:00"}],"pointer":"/paths/~1api~1external~1authentication-events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/external/authentication-events","servers":[{"url":"/_mock/celonis-apis/team-api/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"example":0,"schemaId":"schema_128"},{"name":"pageSize","in":"query","required":false,"example":200,"schemaId":"schema_129"},{"name":"from","in":"query","required":false,"example":"2022-01-01T09:00:00","schemaId":"schema_131"},{"name":"to","in":"query","required":false,"example":"2022-01-31T09:00:00","schemaId":"schema_131"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","204","400","401","403","405","500"],"pointer":"/api/external/authentication-events","href":"login-history-api/findallauthenticationevents","openApiOperationId":"findAllAuthenticationEvents","summary":"List Login History"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/celonis-apis/team-api/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Login History events","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageTransportAuthenticationEventExternalTransport"}},"schemaId":"components/schemas/PageTransportAuthenticationEventExternalTransport"},{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request. Please check the response contents for an explanation of the cause."},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. Check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.celonis.com/en/creating-api-keys.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.celonis.com/en/creating-and-granting-permissions-to-application-keys.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"code":"403","description":"Forbidden"},{"code":"405","description":"Method Not Allowed"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An internal error happened. Please forward the associated error ID along with any helpful information to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.celopeers.com/s/support?language=en_US"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"our support"},"children":[]}]}]}]}]}],"pointer":"/paths/~1api~1external~1authentication-events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageTransportAuthenticationEventExternalTransport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageTransportAuthenticationEventExternalTransport"}}},{"code":"204"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"405"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/login-history-api/findallauthenticationevents"}],"panels":[]}]},"httpPath":"/api/external/authentication-events"}],"content":{"contentType":"group","meta":{"name":"Login History API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Login History API","showPageActions":true},{"nodeType":"markdoc","content":"Allows you to query the Login History for a team and export it for use with external monitoring tools to capture and monitor platform login events."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/external/authentication-events","summary":"List Login History","prefix":{"name":"get","color":"get"},"badges":[],"link":"/login-history-api/findallauthenticationevents","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AuthenticationEventExternalTransport":{"id":"components/schemas/AuthenticationEventExternalTransport","kind":"json-schema","title":"AuthenticationEventExternalTransport","data":{"type":"object","properties":{"authenticationEventType":{"$ref":"#/components/schemas/AuthenticationEventType"},"email":{"type":"string","description":"Email associated with Login History request","example":"email@example.com"},"success":{"type":"boolean","description":"Result of the Login History Event","example":true},"timestamp":{"type":"string","format":"date-time","description":"Date and time when event occurred in ISO 8601 UTC format","example":"2021-01-08T16:36:29.003Z"}}}},"components/schemas/AuthenticationEventType":{"id":"components/schemas/AuthenticationEventType","kind":"json-schema","title":"AuthenticationEventType","data":{"type":"string","description":"Category of the Login History Event","enum":["LOGIN","LOGIN_SSO","LOGIN_CELONIS_ID","LOGIN_OIDC","LOGOUT","ACCOUNT_TEMPORARILY_LOCKED","ACCOUNT_NOT_CONFIRMED","ACCOUNT_NOT_ACTIVE","NOT_MEMBER_OF_TEAM","TEAM_MEMBERSHIP_NOT_ACTIVE","TEAM_MEMBERSHIP_NOT_CONFIRMED","BAD_CREDENTIALS","INVALID_2FA_TOKEN","INVALID_PROVIDER"],"example":"LOGIN"}},"components/schemas/ExternalGroupTransport":{"id":"components/schemas/ExternalGroupTransport","kind":"json-schema","title":"ExternalGroupTransport","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the group","example":"Sample Group"},"teamRole":{"type":"string","description":"Role assigned to group","example":"ANALYST"}}}},"components/schemas/MemberProfileExternalTransport":{"id":"components/schemas/MemberProfileExternalTransport","kind":"json-schema","title":"MemberProfileExternalTransport","data":{"type":"object","properties":{"group":{"type":"array","items":{"$ref":"#/components/schemas/ExternalGroupTransport"}},"inactivityPeriod":{"type":"integer","format":"int64","description":"Number of days in which the user has not logged in.","example":14},"lastLogin":{"type":"string","description":"Date and time when of member last login in UTC format","example":"12/10/2023, 6:49:07 AM UTC"},"nameAndEmail":{"type":"string","description":"Name and email address of member","example":"Lorem Ipsum (email@example.com)"},"status":{"type":"string","description":"Current status of member in his team","example":"Active"},"userId":{"type":"string","description":"Unique identifier of a member","example":"8161c24e-2b32-44eb-bedb-ede2267be989"},"userRole":{"type":"string","description":"Role of the member in the Celonis Platform","example":"MEMBER"}}}},"components/schemas/PageTransportAuthenticationEventExternalTransport":{"id":"components/schemas/PageTransportAuthenticationEventExternalTransport","kind":"json-schema","title":"PageTransportAuthenticationEventExternalTransport","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/AuthenticationEventExternalTransport"}},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int64"}}}},"components/schemas/PageTransportMemberProfileExternalTransport":{"id":"components/schemas/PageTransportMemberProfileExternalTransport","kind":"json-schema","title":"PageTransportMemberProfileExternalTransport","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MemberProfileExternalTransport"}},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int64"}}}},"schema_128":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":0,"minimum":0},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":200,"maximum":200,"minimum":1},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_131"}},"exampleStore":{},"securitySchemeStore":{"Authorization":{"id":"Authorization","type":"apiKey","description":"Prefix the Token with \"AppKey \" or \"Bearer \" (word and space) to indicate the Authorization type","in":"header","paramName":"Authorization"}},"servers":[{"url":"/_mock/celonis-apis/team-api/openapi/openapi","isMockServer":true,"description":"Test Server"}]},"options":{"jsonSamplesExpandLevel":"all","schemasExpansionLevel":2,"codeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"PHP"},{"lang":"Python"}]},"feedback":{"type":"comment","settings":{"label":"Share your feedback for this page.","submitText":"Your comment has been sent to our team!"}},"hideSidebar":true,"mockServer":{"url":"/_mock/celonis-apis/team-api/openapi/openapi","position":"replace","description":"Test Server","off":false,"strictExamples":false,"errorIfForcedExampleNotFound":false},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/celonis-apis/team-api/openapi/openapi.json?download"},{"url":"/_bundle/celonis-apis/team-api/openapi/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"OpenAPI Specification","description":"This is the documentation for the Team API, that allows querying data for a Celonis Platform team."}},"baseSlug":"/celonis-apis/team-api/openapi/openapi","routesMapping":{}}