Manage user profiles using SCIM protocol
Users-SCIM
One or more schemas that are used in the API call. The core schema 'urn:ietf:params:scim:schemas:core:2.0:User' must be always specified.
Custom app data object for app-related user info
- Sandbox environmenthttps://api.sbx.transmitsecurity.io/cis/scim/Users
- Production environment (US)https://api.transmitsecurity.io/cis/scim/Users
- Production environment (EU)https://api.eu.transmitsecurity.io/cis/scim/Users
- Production environment (CA)https://api.ca.transmitsecurity.io/cis/scim/Users
- Production environment (AU)https://api.au.transmitsecurity.io/cis/scim/Users
- cURL
- Node.js
- Go
- JavaScript
- Java
- Python
curl -i -X POST \
https://api.sbx.transmitsecurity.io/cis/scim/Users \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": {
"honorificPrefix": "string",
"givenName": "string",
"familyName": "string",
"middleName": "string"
},
"preferredLanguage": "string",
"emails": [
{
"value": "string",
"primary": false
}
],
"phoneNumbers": [
{
"value": "string",
"primary": false
}
],
"photos": [
"string"
],
"addresses": [
{
"streetAddress": "string",
"locality": "string",
"region": "string",
"postalCode": "string",
"country": "string"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"urn:ietf:params:scim:schemas:extension:CustomAppData:2.0:User": {},
"externalId": "string",
"active": true,
"userName": "string",
"password": "string",
"hashed_password": {
"password": "string",
"salt": "string",
"algorithm": "argon2"
}
}'The user has been successfully created.
List of included SCIM schemas that are used to indicate the attributes contained within a resource.
Unique identifier of the user. In Transmit, the username can be used for password authentication unless a primary email is used instead.
Indicates the user's preferred written or spoken languages and is generally used for selecting a localized user interface
A URI that is a uniform resource locator (as defined in Section 1.1.3 of [RFC3986]) that points to a resource location representing the user's image.
Custom app data object for app-related user info
The last time the user authenticated
Whether the password is currently expired
Whether the password must be reset after first use
{ "schemas": [ "string" ], "userName": "string", "name": { "honorificPrefix": "string", "givenName": "string", "familyName": "string", "middleName": "string" }, "displayName": "string", "preferredLanguage": "string", "active": true, "emails": [ "string" ], "phoneNumbers": [ "string" ], "photos": [ "string" ], "addresses": [ "string" ], "id": "string", "externalId": "string", "meta": { "resourceType": "string", "created": "2019-08-24T14:15:22Z", "lastModified": "2019-08-24T14:15:22Z", "location": "string" }, "urn:ietf:params:scim:schemas:extension:CustomAppData:2.0:User": {}, "urn:ietf:params:scim:schemas:extension:UserExtended:2.0:User": { "status": "Active", "lastAuth": "2019-08-24T14:15:22Z", "passwordInformation": { … } } }
The name of the field you wish to sort by
Search expression based on the SCIM protocol. For syntax and searchable fields, see Search query syntax
The names of the user's attributes to return in the response, overriding the set of attributes that would be returned by default
- Sandbox environmenthttps://api.sbx.transmitsecurity.io/cis/scim/Users
- Production environment (US)https://api.transmitsecurity.io/cis/scim/Users
- Production environment (EU)https://api.eu.transmitsecurity.io/cis/scim/Users
- Production environment (CA)https://api.ca.transmitsecurity.io/cis/scim/Users
- Production environment (AU)https://api.au.transmitsecurity.io/cis/scim/Users
- cURL
- Node.js
- Go
- JavaScript
- Java
- Python
curl -i -X GET \
'https://api.sbx.transmitsecurity.io/cis/scim/Users?startIndex=1&count=1000&sortBy=emails&sortOrder=asc&filter=string&attributes=string&excludedAttributes=string' \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'The returned users
List of included SCIM schemas that are used to indicate the attributes contained within a resource.
Unique identifier of the user. In Transmit, the username can be used for password authentication unless a primary email is used instead.
Indicates the user's preferred written or spoken languages and is generally used for selecting a localized user interface
A URI that is a uniform resource locator (as defined in Section 1.1.3 of [RFC3986]) that points to a resource location representing the user's image.
The date time that the resource was last modified
Custom app data object for app-related user info
The last time the user authenticated
Whether the password is currently expired
Whether the password must be reset after first use
{ "schemas": [ "string" ], "totalResults": 0, "Resources": [ { … } ], "startIndex": 0, "itemsPerPage": 0 }
The name of the field you wish to sort by
Search expression based on the SCIM protocol. For syntax and searchable fields, see Search query syntax
The names of the user's attributes to return in the response, overriding the set of attributes that would be returned by default
The names of the user's attributes to be removed from the default set of attributes to return
- Sandbox environmenthttps://api.sbx.transmitsecurity.io/cis/scim/Users/.search
- Production environment (US)https://api.transmitsecurity.io/cis/scim/Users/.search
- Production environment (EU)https://api.eu.transmitsecurity.io/cis/scim/Users/.search
- Production environment (CA)https://api.ca.transmitsecurity.io/cis/scim/Users/.search
- Production environment (AU)https://api.au.transmitsecurity.io/cis/scim/Users/.search
- cURL
- Node.js
- Go
- JavaScript
- Java
- Python
curl -i -X POST \
https://api.sbx.transmitsecurity.io/cis/scim/Users/.search \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"startIndex": 1,
"count": 1000,
"sortBy": "emails",
"sortOrder": "asc",
"filter": "string",
"attributes": [
"string"
],
"excludedAttributes": [
"string"
],
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:SearchRequest"
]
}'The returned users
List of included SCIM schemas that are used to indicate the attributes contained within a resource.
Unique identifier of the user. In Transmit, the username can be used for password authentication unless a primary email is used instead.
Indicates the user's preferred written or spoken languages and is generally used for selecting a localized user interface
A URI that is a uniform resource locator (as defined in Section 1.1.3 of [RFC3986]) that points to a resource location representing the user's image.
The date time that the resource was last modified
Custom app data object for app-related user info
The last time the user authenticated
Whether the password is currently expired
Whether the password must be reset after first use
{ "schemas": [ "string" ], "totalResults": 0, "Resources": [ { … } ], "startIndex": 0, "itemsPerPage": 0 }
- Sandbox environmenthttps://api.sbx.transmitsecurity.io/cis/scim/Users/{user_id}
- Production environment (US)https://api.transmitsecurity.io/cis/scim/Users/{user_id}
- Production environment (EU)https://api.eu.transmitsecurity.io/cis/scim/Users/{user_id}
- Production environment (CA)https://api.ca.transmitsecurity.io/cis/scim/Users/{user_id}
- Production environment (AU)https://api.au.transmitsecurity.io/cis/scim/Users/{user_id}
- cURL
- Node.js
- Go
- JavaScript
- Java
- Python
curl -i -X GET \
'https://api.sbx.transmitsecurity.io/cis/scim/Users/{user_id}' \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'List of included SCIM schemas that are used to indicate the attributes contained within a resource.
Unique identifier of the user. In Transmit, the username can be used for password authentication unless a primary email is used instead.
Indicates the user's preferred written or spoken languages and is generally used for selecting a localized user interface
A URI that is a uniform resource locator (as defined in Section 1.1.3 of [RFC3986]) that points to a resource location representing the user's image.
Custom app data object for app-related user info
The last time the user authenticated
Whether the password is currently expired
Whether the password must be reset after first use
{ "schemas": [ "string" ], "userName": "string", "name": { "honorificPrefix": "string", "givenName": "string", "familyName": "string", "middleName": "string" }, "displayName": "string", "preferredLanguage": "string", "active": true, "emails": [ "string" ], "phoneNumbers": [ "string" ], "photos": [ "string" ], "addresses": [ "string" ], "id": "string", "externalId": "string", "meta": { "resourceType": "string", "created": "2019-08-24T14:15:22Z", "lastModified": "2019-08-24T14:15:22Z", "location": "string" }, "urn:ietf:params:scim:schemas:extension:CustomAppData:2.0:User": {}, "urn:ietf:params:scim:schemas:extension:UserExtended:2.0:User": { "status": "Active", "lastAuth": "2019-08-24T14:15:22Z", "passwordInformation": { … } } }
One or more schemas that are used in the API call. The core schema 'urn:ietf:params:scim:schemas:core:2.0:User' must be always specified.
Custom app data object for app-related user info
- Sandbox environmenthttps://api.sbx.transmitsecurity.io/cis/scim/Users/{user_id}
- Production environment (US)https://api.transmitsecurity.io/cis/scim/Users/{user_id}
- Production environment (EU)https://api.eu.transmitsecurity.io/cis/scim/Users/{user_id}
- Production environment (CA)https://api.ca.transmitsecurity.io/cis/scim/Users/{user_id}
- Production environment (AU)https://api.au.transmitsecurity.io/cis/scim/Users/{user_id}
- cURL
- Node.js
- Go
- JavaScript
- Java
- Python
curl -i -X PUT \
'https://api.sbx.transmitsecurity.io/cis/scim/Users/{user_id}' \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": {
"honorificPrefix": "string",
"givenName": "string",
"familyName": "string",
"middleName": "string"
},
"preferredLanguage": "string",
"emails": [
{
"value": "string",
"primary": false
}
],
"phoneNumbers": [
{
"value": "string",
"primary": false
}
],
"photos": [
"string"
],
"addresses": [
{
"streetAddress": "string",
"locality": "string",
"region": "string",
"postalCode": "string",
"country": "string"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"urn:ietf:params:scim:schemas:extension:CustomAppData:2.0:User": {},
"externalId": "string",
"active": true,
"userName": "string",
"password": "string",
"hashed_password": {
"password": "string",
"salt": "string",
"algorithm": "argon2"
}
}'The user attributes have been successfully replaced.
List of included SCIM schemas that are used to indicate the attributes contained within a resource.
Unique identifier of the user. In Transmit, the username can be used for password authentication unless a primary email is used instead.
Indicates the user's preferred written or spoken languages and is generally used for selecting a localized user interface
A URI that is a uniform resource locator (as defined in Section 1.1.3 of [RFC3986]) that points to a resource location representing the user's image.
Custom app data object for app-related user info
The last time the user authenticated
Whether the password is currently expired
Whether the password must be reset after first use
{ "schemas": [ "string" ], "userName": "string", "name": { "honorificPrefix": "string", "givenName": "string", "familyName": "string", "middleName": "string" }, "displayName": "string", "preferredLanguage": "string", "active": true, "emails": [ "string" ], "phoneNumbers": [ "string" ], "photos": [ "string" ], "addresses": [ "string" ], "id": "string", "externalId": "string", "meta": { "resourceType": "string", "created": "2019-08-24T14:15:22Z", "lastModified": "2019-08-24T14:15:22Z", "location": "string" }, "urn:ietf:params:scim:schemas:extension:CustomAppData:2.0:User": {}, "urn:ietf:params:scim:schemas:extension:UserExtended:2.0:User": { "status": "Active", "lastAuth": "2019-08-24T14:15:22Z", "passwordInformation": { … } } }
- Sandbox environmenthttps://api.sbx.transmitsecurity.io/cis/scim/Users/{user_id}
- Production environment (US)https://api.transmitsecurity.io/cis/scim/Users/{user_id}
- Production environment (EU)https://api.eu.transmitsecurity.io/cis/scim/Users/{user_id}
- Production environment (CA)https://api.ca.transmitsecurity.io/cis/scim/Users/{user_id}
- Production environment (AU)https://api.au.transmitsecurity.io/cis/scim/Users/{user_id}
- cURL
- Node.js
- Go
- JavaScript
- Java
- Python
curl -i -X DELETE \
'https://api.sbx.transmitsecurity.io/cis/scim/Users/{user_id}' \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'