Indexing API
- Documents
- Permissions
- Troubleshooting
- Datasources
- Authentication
- People
- Shortcuts
Client API
- Activity
- Announcements
- Answers
- Authentication
- Calendar
- Chat
- Agents
- Collections
- Displayable Lists
- Documents
- Images
- Insights
- Messages
- Pins
- Search
- Entities
- Shortcuts
- Summarize
- Tools
- User
- Verification
Actions API
- Authentication
- Setup
Index team
Adds a team or updates information about a team
curl --request POST \
--url https://{domain}-be.glean.com/api/index/v1/indexteam \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json; charset=UTF-8' \
--data '{
"team": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"businessUnit": "<string>",
"department": "<string>",
"photoUrl": "<string>",
"externalLink": "<string>",
"emails": [
{
"email": "jsmith@example.com",
"type": "OTHER"
}
],
"datasourceProfiles": [
{
"datasource": "github",
"handle": "<string>",
"url": "<string>",
"nativeAppUrl": "<string>",
"isUserGenerated": true
}
],
"members": [
{
"email": "jsmith@example.com",
"relationship": "MEMBER",
"join_date": "2023-12-25"
}
],
"additionalFields": [
{
"key": "<string>",
"value": [
{}
]
}
]
},
"version": 123
}'Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Info about a team and optional version for that info
Info about the team
The unique ID of the team
Human-readable team name
The members of the team
Information about a team's member
The description of this team
Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses.
An organizational unit where everyone has a similar task, e.g. Engineering.
A link to the team's photo
A link to an external team page. If set, team results will link to it.
The datasource profiles of the team, e.g. Slack,Github.
The datasource the profile is of.
"github"
The display name of the entity in the given datasource.
URL to view the entity's profile.
A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...).
For internal use only. True iff the data source profile was manually added by a user from within Glean (aka not from the original data source)
List of additional fields with more information about the team.
Additional information about the employee or team.
Key to reference this field, e.g. "languages". Note that the key should be all lowercase alphabetic characters with no numbers, spaces, hyphens or underscores.
List of type string or HypertextField.
HypertextField is defined as
{
anchor: string, // Anchor text for the hypertext field.
hyperlink: string, // URL for the hypertext field.
}
Example: {"anchor":"Glean","hyperlink":"https://glean.com"}
When OpenAPI Generator supports oneOf, we will semantically enforce this in the docs.
Note: If using the Python SDK to pass in a list of strings, the value may need to be a list of dictionaries. In that case, the key in that dictionary will be ignored.
Example: "languages": [{"lang":"English","lang":"Spanish",...}]. In this case, the key "lang" will be ignored and can even be passed in as an empty string.
Either a string or HypertextField. When OpenAPI Generator supports oneOf, we can semantically enforce this in the docs.
Version number for the team object. If absent or 0 then no version checks are done
Response
OK
Was this page helpful?
curl --request POST \
--url https://{domain}-be.glean.com/api/index/v1/indexteam \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json; charset=UTF-8' \
--data '{
"team": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"businessUnit": "<string>",
"department": "<string>",
"photoUrl": "<string>",
"externalLink": "<string>",
"emails": [
{
"email": "jsmith@example.com",
"type": "OTHER"
}
],
"datasourceProfiles": [
{
"datasource": "github",
"handle": "<string>",
"url": "<string>",
"nativeAppUrl": "<string>",
"isUserGenerated": true
}
],
"members": [
{
"email": "jsmith@example.com",
"relationship": "MEMBER",
"join_date": "2023-12-25"
}
],
"additionalFields": [
{
"key": "<string>",
"value": [
{}
]
}
]
},
"version": 123
}'